Developer Guide

Welcome to the Leaspy Developer Documentation.

This section is for contributors who want to understand the internal engine of Leaspy. If you just want to use Leaspy to analyze data, check out the User Guide.

Codebase Internals

These pages explain how Leaspy works under the hood: the architecture, the model contracts, and the algorithm pipelines.

Internals

• Codebase Deep Dive
  • Architecture & Data Flow
  • ModelInterface
  • BaseModel
  • StatefulModel
  • McmcSaemCompatibleModel
  • TimeReparametrizedModel
  • RiemanianManifoldModel
  • LogisticModel
  • LogisticInitializationMixin
  • Observation Models
  • The Variables DAG
  • Data & Dataset
  • Internal Vocabulary

Contribution Workflows

Process guides for developing, testing, and releasing Leaspy.

• Contribution Guide
  • Key Concepts
  • Repository Structure
  • Initial Setup (First-Time Contributors)
  • Creating a Pull Request
  • Handling Upstream Changes
  • Resolving Conflicts
  • Code Review Process
  • Troubleshooting
• Dependency Management & Security Policy
  • Overview
  • Core Philosophy: Conservative Updates
  • Security Vulnerability Workflow
  • Specific Package Policies
  • Developer protocol
• Releasing a New Version
  • 1. Determine Release Type
  • 2. Prerequisites
  • 3. Update Version Numbers
  • 4. Update Changelog
  • 5. Verify CI Configuration
  • 6. Branch, Commit, and Review
  • 7. Create Release on GitHub
  • Mandatory Release Protocol