# jbei/kineticlearning architecture

> Architecture diagram of the GitHub repository jbei/kineticlearning, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jbei/kineticlearning
- Repository: https://github.com/jbei/kineticlearning

## Overview

Kinetic Learning is a Python toolkit and notebook-based workflow for inferring and analyzing dynamical models from time-series measurements. Users prepare or load time-series data, estimate state derivatives, fit learned dynamics, and simulate trajectories; notebooks also support simulated-data creation and domain analyses. The package exposes these stages, while a separate plotting module provides model and learning-curve visualizations. README claims establish notebook capabilities, but the notebook bodies were not sampled, so their internal calls and links to particular data files are not asserted.

Main entry points: [`KineticLearning/__init__.py`](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py) (Data preparation), [`notebooks/LearnLimoneneDynamics.ipynb`](https://github.com/jbei/kineticlearning/blob/master/notebooks/LearnLimoneneDynamics.ipynb) (Model analysis), [`notebooks/Create Data Set.ipynb`](https://github.com/jbei/kineticlearning/blob/master/notebooks/Create%20Data%20Set.ipynb) (Create datasets), [`data`](https://github.com/jbei/kineticlearning/tree/master/data) (Time-series data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Notebook workflows"]
  node_dataset_notebook["Create datasets"]
  node_analysis_notebook["Model analysis"]
end

subgraph group_modeling["Dynamics modeling"]
  node_prepare["Data preparation<br/>[__init__.py]"]
  node_augment["Data augmentation<br/>[__init__.py]"]
  node_derivatives["Derivative estimates<br/>[__init__.py]"]
  node_model_search["Model search<br/>[__init__.py]"]
  node_dynamic_model["Dynamic model<br/>[__init__.py]"]
  node_simulate["Trajectory simulation<br/>[__init__.py]"]
  node_integrator["ODE integrator<br/>[__init__.py]"]
end

subgraph group_analysis["Analysis and visualization"]
  node_fit_check["Derivative checks<br/>[__init__.py]"]
  node_plot_tools["Plot utilities<br/>[plot.py]"]
  node_legacy_helpers["Legacy fit analysis<br/>[helper.py]"]
end

node_user(("Researcher"))
node_measurements["Time-series data"]
node_tpot["TPOT regression"]

node_user -->|"runs"| node_dataset_notebook
node_user -->|"runs"| node_analysis_notebook
node_dataset_notebook -.->|"creates data"| node_measurements
node_analysis_notebook -.->|"builds models"| node_prepare
node_measurements -->|"loads CSV"| node_prepare
node_prepare -->|"augments"| node_augment
node_prepare -->|"estimates"| node_derivatives
node_prepare -->|"returns data"| node_model_search
node_model_search -->|"fits"| node_dynamic_model
node_model_search -->|"searches models"| node_tpot
node_dynamic_model -->|"trains on"| node_derivatives
node_dynamic_model -->|"predicts in"| node_simulate
node_simulate -->|"integrates with"| node_integrator
node_fit_check -->|"reconstructs with"| node_integrator
node_analysis_notebook -.->|"analyzes with"| node_plot_tools
node_legacy_helpers -->|"fits and simulates"| node_dynamic_model

click node_dataset_notebook "https://github.com/jbei/kineticlearning/blob/master/notebooks/Create%20Data%20Set.ipynb"
click node_analysis_notebook "https://github.com/jbei/kineticlearning/blob/master/notebooks/LearnLimoneneDynamics.ipynb"
click node_measurements "https://github.com/jbei/kineticlearning/tree/master/data"
click node_prepare "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_augment "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_derivatives "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_model_search "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_dynamic_model "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_simulate "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_integrator "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_fit_check "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py"
click node_plot_tools "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/plot.py"
click node_legacy_helpers "https://github.com/jbei/kineticlearning/blob/master/KineticLearning/helper.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dataset_notebook,node_analysis_notebook toneBlue
class node_prepare,node_augment,node_derivatives,node_model_search,node_dynamic_model,node_simulate,node_integrator toneAmber
class node_fit_check,node_plot_tools,node_legacy_helpers toneMint
class node_user,node_tpot toneIndigo
class node_measurements toneTeal
```

## Components

### Notebook workflows

- [Create datasets](https://github.com/jbei/kineticlearning/blob/master/notebooks/Create%20Data%20Set.ipynb): `notebooks/Create Data Set.ipynb`
- [Model analysis](https://github.com/jbei/kineticlearning/blob/master/notebooks/LearnLimoneneDynamics.ipynb): `notebooks/LearnLimoneneDynamics.ipynb`

### Dynamics modeling

- [Data preparation](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Data augmentation](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Derivative estimates](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Model search](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Dynamic model](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Trajectory simulation](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [ODE integrator](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`

### Analysis and visualization

- [Derivative checks](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/__init__.py): `KineticLearning/__init__.py`
- [Plot utilities](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/plot.py): `KineticLearning/plot.py`
- [Legacy fit analysis](https://github.com/jbei/kineticlearning/blob/master/KineticLearning/helper.py): `KineticLearning/helper.py`

### Other components

- **Researcher**
- [Time-series data](https://github.com/jbei/kineticlearning/tree/master/data): `data`
- **TPOT regression**

## Connections

- Researcher → Create datasets: runs (evidence: `README.md`)
- Researcher → Model analysis: runs (evidence: `README.md`)
- Create datasets → Time-series data: creates data
- Model analysis → Data preparation: builds models (evidence: `README.md`)
- Time-series data → Data preparation: loads CSV (evidence: `KineticLearning/__init__.py`)
- Data preparation → Data augmentation: augments (evidence: `KineticLearning/__init__.py`)
- Data preparation → Derivative estimates: estimates (evidence: `KineticLearning/__init__.py`)
- Data preparation → Model search: returns data (evidence: `KineticLearning/__init__.py`)
- Model search → Dynamic model: fits (evidence: `KineticLearning/__init__.py`)
- Model search → TPOT regression: searches models (evidence: `KineticLearning/__init__.py`)
- Dynamic model → Derivative estimates: trains on (evidence: `KineticLearning/__init__.py`)
- Dynamic model → Trajectory simulation: predicts in (evidence: `KineticLearning/__init__.py`)
- Trajectory simulation → ODE integrator: integrates with (evidence: `KineticLearning/__init__.py`)
- Derivative checks → ODE integrator: reconstructs with (evidence: `KineticLearning/__init__.py`)
- Model analysis → Plot utilities: analyzes with
- Legacy fit analysis → Dynamic model: fits and simulates (evidence: `KineticLearning/helper.py`)
