# maxi-fr/simulate architecture

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

- Interactive diagram: https://gitdiagram.com/maxi-fr/simulate
- Repository: https://github.com/maxi-fr/simulate

## Overview

The product is a configuration-driven control-system simulator, extended with spacecraft dynamics and ADCS models. Its main workflow loads configuration, assembles multi-rate components, advances a closed loop, and records results; batch experiments are a separate execution option. The spacecraft package adds rigid-body/orbit modeling, effectors, environment and attitude utilities, plus estimation and measurement capabilities. Edges reflect the excerpts, SOURCE INDEX references, and README; unsampled runtime details are not inferred beyond those sources.

Main entry points: [`src/simulate/simulation.py`](https://github.com/maxi-fr/simulate/blob/main/src/simulate/simulation.py) (Loop orchestrator), [`src/spacecraft/rigid_body.py`](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/rigid_body.py) (Rigid-body dynamics), [`src/spacecraft/effector.py`](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/effector.py) (Actuators and effectors), [`src/spacecraft/measurement.py`](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/measurement.py) (Spacecraft measurements)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_engine["Simulation engine"]
  node_cli["CLI<br/>[main.py]"]
  node_config["Config loader<br/>[config.py]"]
  node_simulation["Loop orchestrator<br/>[simulation.py]"]
  node_component["Component and ZOH<br/>[component.py]"]
end

subgraph group_control["Control components"]
  node_dynamics["Dynamics<br/>[dynamics.py]"]
  node_integrator["Numerical integrators<br/>[integrator.py]"]
  node_reference["Reference signals<br/>[reference.py]"]
  node_sensor["Sensors and measurements<br/>[sensor.py]"]
  node_estimator["State estimators<br/>[estimator.py]"]
  node_controller["Controllers<br/>[controller.py]"]
end

subgraph group_logging["Logging and runs"]
  node_logger["Logging backends<br/>[base.py]"]
  node_experiment["Batch experiments<br/>[experiment.py]"]
end

subgraph group_spacecraft["Spacecraft models"]
  node_rigidbody["Rigid-body dynamics<br/>[rigid_body.py]"]
  node_effector["Actuators and effectors<br/>[effector.py]"]
  node_orbit["Orbit propagation<br/>[orbit_dynamics.py]"]
  node_frames["Reference frames<br/>[frames.py]"]
  node_quaternion["Quaternion math<br/>[quaternion.py]"]
  node_environment["Space environment<br/>[environment.py]"]
  node_disturbances["Environmental torques<br/>[disturbances.py]"]
  node_surface["Spacecraft surfaces<br/>[surface.py]"]
  node_sc_estimator["ADCS estimators<br/>[estimator.py]"]
  node_measurement["Spacecraft measurements<br/>[measurement.py]"]
end

node_user(("Simulation user"))

node_user -->|"invokes"| node_cli
node_user -->|"provides configuration"| node_config
node_cli -->|"loads"| node_config
node_cli -->|"runs"| node_simulation
node_cli -->|"dispatches batches"| node_experiment
node_simulation -->|"builds components"| node_config
node_simulation -->|"advances"| node_dynamics
node_simulation -->|"evaluates"| node_reference
node_simulation -->|"samples"| node_sensor
node_simulation -->|"estimates state"| node_estimator
node_simulation -->|"computes control"| node_controller
node_simulation -->|"records results"| node_logger
node_dynamics -->|"inherits"| node_component
node_reference -->|"inherits"| node_component
node_sensor -->|"inherits"| node_component
node_estimator -->|"inherits"| node_component
node_controller -->|"inherits"| node_component
node_dynamics -->|"integrates with"| node_integrator
node_estimator -->|"integrates with"| node_integrator
node_experiment -->|"runs configurations"| node_simulation
node_rigidbody -->|"extends"| node_dynamics
node_rigidbody -->|"composes"| node_effector
node_rigidbody -->|"uses"| node_frames
node_rigidbody -->|"uses"| node_orbit
node_rigidbody -->|"uses"| node_quaternion
node_effector -->|"queries"| node_environment
node_effector -->|"uses"| node_disturbances
node_effector -->|"uses"| node_surface
node_effector -->|"uses"| node_frames
node_effector -->|"uses"| node_orbit
node_disturbances -->|"queries"| node_environment
node_disturbances -->|"uses"| node_quaternion
node_disturbances -->|"uses"| node_surface
node_frames -->|"uses"| node_quaternion
node_sc_estimator -->|"uses"| node_orbit
node_sc_estimator -->|"uses"| node_quaternion
node_measurement -->|"queries"| node_environment
node_measurement -->|"uses"| node_frames
node_measurement -->|"uses"| node_quaternion
node_measurement -->|"reads state"| node_rigidbody
node_rigidbody -->|"runs as component"| node_simulation
node_sc_estimator -->|"runs as component"| node_simulation
node_measurement -->|"runs as component"| node_simulation

click node_cli "https://github.com/maxi-fr/simulate/blob/main/src/simulate/main.py"
click node_config "https://github.com/maxi-fr/simulate/blob/main/src/simulate/config.py"
click node_simulation "https://github.com/maxi-fr/simulate/blob/main/src/simulate/simulation.py"
click node_component "https://github.com/maxi-fr/simulate/blob/main/src/simulate/component.py"
click node_dynamics "https://github.com/maxi-fr/simulate/blob/main/src/simulate/dynamics.py"
click node_integrator "https://github.com/maxi-fr/simulate/blob/main/src/simulate/integrator.py"
click node_reference "https://github.com/maxi-fr/simulate/blob/main/src/simulate/reference.py"
click node_sensor "https://github.com/maxi-fr/simulate/blob/main/src/simulate/sensor.py"
click node_estimator "https://github.com/maxi-fr/simulate/blob/main/src/simulate/estimator.py"
click node_controller "https://github.com/maxi-fr/simulate/blob/main/src/simulate/controller.py"
click node_logger "https://github.com/maxi-fr/simulate/blob/main/src/simulate/logger/base.py"
click node_experiment "https://github.com/maxi-fr/simulate/blob/main/src/simulate/experiment.py"
click node_rigidbody "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/rigid_body.py"
click node_effector "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/effector.py"
click node_orbit "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/orbit_dynamics.py"
click node_frames "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/frames.py"
click node_quaternion "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/quaternion.py"
click node_environment "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/environment.py"
click node_disturbances "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/disturbances.py"
click node_surface "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/surface.py"
click node_sc_estimator "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/estimator.py"
click node_measurement "https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/measurement.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_cli,node_config,node_simulation,node_component,node_user toneBlue
class node_dynamics,node_integrator,node_reference,node_sensor,node_estimator,node_controller toneAmber
class node_logger,node_experiment toneMint
class node_rigidbody,node_effector,node_orbit,node_frames,node_quaternion,node_environment,node_disturbances,node_surface,node_sc_estimator,node_measurement toneRose
```

## Components

### Simulation engine

- [CLI](https://github.com/maxi-fr/simulate/blob/main/src/simulate/main.py): `src/simulate/main.py`
- [Config loader](https://github.com/maxi-fr/simulate/blob/main/src/simulate/config.py): `src/simulate/config.py`
- [Loop orchestrator](https://github.com/maxi-fr/simulate/blob/main/src/simulate/simulation.py): `src/simulate/simulation.py`
- [Component and ZOH](https://github.com/maxi-fr/simulate/blob/main/src/simulate/component.py): `src/simulate/component.py`

### Control components

- [Dynamics](https://github.com/maxi-fr/simulate/blob/main/src/simulate/dynamics.py): `src/simulate/dynamics.py`
- [Numerical integrators](https://github.com/maxi-fr/simulate/blob/main/src/simulate/integrator.py): `src/simulate/integrator.py`
- [Reference signals](https://github.com/maxi-fr/simulate/blob/main/src/simulate/reference.py): `src/simulate/reference.py`
- [Sensors and measurements](https://github.com/maxi-fr/simulate/blob/main/src/simulate/sensor.py): `src/simulate/sensor.py`
- [State estimators](https://github.com/maxi-fr/simulate/blob/main/src/simulate/estimator.py): `src/simulate/estimator.py`
- [Controllers](https://github.com/maxi-fr/simulate/blob/main/src/simulate/controller.py): `src/simulate/controller.py`

### Logging and runs

- [Logging backends](https://github.com/maxi-fr/simulate/blob/main/src/simulate/logger/base.py): `src/simulate/logger/base.py`
- [Batch experiments](https://github.com/maxi-fr/simulate/blob/main/src/simulate/experiment.py): `src/simulate/experiment.py`

### Spacecraft models

- [Rigid-body dynamics](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/rigid_body.py): `src/spacecraft/rigid_body.py`
- [Actuators and effectors](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/effector.py): `src/spacecraft/effector.py`
- [Orbit propagation](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/orbit_dynamics.py): `src/spacecraft/orbit_dynamics.py`
- [Reference frames](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/frames.py): `src/spacecraft/frames.py`
- [Quaternion math](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/quaternion.py): `src/spacecraft/quaternion.py`
- [Space environment](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/environment.py): `src/spacecraft/environment.py`
- [Environmental torques](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/disturbances.py): `src/spacecraft/disturbances.py`
- [Spacecraft surfaces](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/surface.py): `src/spacecraft/surface.py`
- [ADCS estimators](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/estimator.py): `src/spacecraft/estimator.py`
- [Spacecraft measurements](https://github.com/maxi-fr/simulate/blob/main/src/spacecraft/measurement.py): `src/spacecraft/measurement.py`

### Other components

- **Simulation user**

## Connections

- Simulation user → CLI: invokes (evidence: `README.md`)
- Simulation user → Config loader: provides configuration (evidence: `README.md`)
- CLI → Config loader: loads (evidence: `src/simulate/main.py`)
- CLI → Loop orchestrator: runs (evidence: `src/simulate/main.py`)
- CLI → Batch experiments: dispatches batches (evidence: `src/simulate/main.py`)
- Loop orchestrator → Config loader: builds components (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → Dynamics: advances (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → Reference signals: evaluates (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → Sensors and measurements: samples (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → State estimators: estimates state (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → Controllers: computes control (evidence: `src/simulate/simulation.py`)
- Loop orchestrator → Logging backends: records results (evidence: `src/simulate/simulation.py`)
- Dynamics → Component and ZOH: inherits (evidence: `src/simulate/dynamics.py`)
- Reference signals → Component and ZOH: inherits (evidence: `src/simulate/reference.py`)
- Sensors and measurements → Component and ZOH: inherits (evidence: `src/simulate/sensor.py`)
- State estimators → Component and ZOH: inherits (evidence: `src/simulate/estimator.py`)
- Controllers → Component and ZOH: inherits (evidence: `src/simulate/controller.py`)
- Dynamics → Numerical integrators: integrates with (evidence: `src/simulate/dynamics.py`)
- State estimators → Numerical integrators: integrates with (evidence: `src/simulate/estimator.py`)
- Batch experiments → Loop orchestrator: runs configurations (evidence: `src/simulate/experiment.py`)
- Rigid-body dynamics → Dynamics: extends (evidence: `src/spacecraft/rigid_body.py`)
- Rigid-body dynamics → Actuators and effectors: composes (evidence: `src/spacecraft/rigid_body.py`)
- Rigid-body dynamics → Reference frames: uses (evidence: `src/spacecraft/rigid_body.py`)
- Rigid-body dynamics → Orbit propagation: uses (evidence: `src/spacecraft/rigid_body.py`)
- Rigid-body dynamics → Quaternion math: uses (evidence: `src/spacecraft/rigid_body.py`)
- Actuators and effectors → Space environment: queries (evidence: `src/spacecraft/effector.py`)
- Actuators and effectors → Environmental torques: uses (evidence: `src/spacecraft/effector.py`)
- Actuators and effectors → Spacecraft surfaces: uses (evidence: `src/spacecraft/effector.py`)
- Actuators and effectors → Reference frames: uses (evidence: `src/spacecraft/effector.py`)
- Actuators and effectors → Orbit propagation: uses (evidence: `src/spacecraft/effector.py`)
- Environmental torques → Space environment: queries (evidence: `src/spacecraft/disturbances.py`)
- Environmental torques → Quaternion math: uses (evidence: `src/spacecraft/disturbances.py`)
- Environmental torques → Spacecraft surfaces: uses (evidence: `src/spacecraft/disturbances.py`)
- Reference frames → Quaternion math: uses (evidence: `src/spacecraft/frames.py`)
- ADCS estimators → Orbit propagation: uses (evidence: `src/spacecraft/estimator.py`)
- ADCS estimators → Quaternion math: uses (evidence: `src/spacecraft/estimator.py`)
- Spacecraft measurements → Space environment: queries (evidence: `src/spacecraft/measurement.py`)
- Spacecraft measurements → Reference frames: uses (evidence: `src/spacecraft/measurement.py`)
- Spacecraft measurements → Quaternion math: uses (evidence: `src/spacecraft/measurement.py`)
- Spacecraft measurements → Rigid-body dynamics: reads state (evidence: `src/spacecraft/measurement.py`)
- Rigid-body dynamics → Loop orchestrator: runs as component (evidence: `README.md`)
- ADCS estimators → Loop orchestrator: runs as component (evidence: `README.md`)
- Spacecraft measurements → Loop orchestrator: runs as component (evidence: `README.md`)
