# gundam-organization/gundam architecture

> Architecture diagram of the GitHub repository gundam-organization/gundam, 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/gundam-organization/gundam
- Repository: https://github.com/gundam-organization/gundam
- Video tour (about a minute): https://gitdiagram.com/gundam-organization/gundam/video

## Overview

GUNDAM is a configurable neutrino-analysis and fitting framework. Users provide YAML/JSON configuration and data inputs; dataset loading prepares samples, parameters and dial definitions drive event reweighting, and likelihood evaluation feeds fit/minimization and analysis outputs. The map preserves the documented cross-section and oscillation-analysis scope, plus parameter scans, plots, event-tree output and Python access. Several links are dashed because the available excerpts and source index do not establish their runtime call direction.

Main entry points: [`src/StatisticalInference/Likelihood/src/LikelihoodInterface.cpp`](https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/Likelihood/src/LikelihoodInterface.cpp) (Likelihood), [`src/PythonInterface/src/PythonInterface.cpp`](https://github.com/gundam-organization/gundam/blob/main/src/PythonInterface/src/PythonInterface.cpp) (Python interface), [`src/Fitter/Engine/src/FitterEngine.cpp`](https://github.com/gundam-organization/gundam/blob/main/src/Fitter/Engine/src/FitterEngine.cpp) (Fitter engine), [`src/Propagator/src/Propagator.cpp`](https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/Propagator.cpp) (Propagator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Inputs and samples"]
  node_dataset["Dataset definition"]
  node_loader["Data dispenser<br/>[DataDispenser.cpp]"]
  node_samples["Sample set<br/>[SampleSet.cpp]"]
end

subgraph group_model["Fit model"]
  node_params["Parameter manager"]
  node_dials["Dial engine<br/>[DialManager.cpp]"]
  node_eventcache["Event dial cache<br/>[EventDialCache.h]"]
end

subgraph group_inference["Statistical inference"]
  node_likelihood["Likelihood"]
  node_jointprob["Joint probability"]
  node_fitter["Fitter engine<br/>[FitterEngine.cpp]"]
  node_minimizer["Minimizers<br/>[RootMinimizer.cpp]"]
  node_scanner["Parameter scanner"]
end

subgraph group_runtime["Execution and results"]
  node_propagator["Propagator<br/>[Propagator.cpp]"]
  node_cache["Weight cache<br/>[CacheManager.cpp]"]
  node_plots["Plot generator<br/>[PlotGenerator.cpp]"]
  node_eventwriter["Event tree writer"]
end

subgraph group_interfaces["User interfaces"]
  node_config["Config utilities<br/>[ConfigUtils.cpp]"]
  node_python["Python interface"]
end

node_analyst(("Analyst"))

node_analyst -->|"provides config"| node_config
node_config -.->|"configures"| node_dataset
node_dataset -->|"owns dispensers"| node_loader
node_loader -.->|"loads events"| node_samples
node_params -.->|"supplies parameters"| node_dials
node_dials -.->|"builds event cache"| node_eventcache
node_propagator -->|"uses parameters"| node_params
node_propagator -->|"reweights samples"| node_samples
node_propagator -->|"uses dial cache"| node_eventcache
node_cache -->|"updates samples"| node_samples
node_cache -->|"updates weights"| node_eventcache
node_likelihood -->|"evaluates model"| node_propagator
node_likelihood -->|"computes probability"| node_jointprob
node_fitter -.->|"fits likelihood"| node_likelihood
node_fitter -->|"selects minimizer"| node_minimizer
node_fitter -->|"uses weight cache"| node_cache
node_scanner -.->|"scans parameters"| node_likelihood
node_likelihood -->|"exposes plotting"| node_plots
node_likelihood -->|"exposes event output"| node_eventwriter
node_analyst -.->|"uses Python API"| node_python
node_python -->|"accesses fitting"| node_fitter
node_python -->|"accesses datasets"| node_dataset
node_python -->|"accesses parameters"| node_params

click node_config "https://github.com/gundam-organization/gundam/blob/main/src/Utils/src/ConfigUtils.cpp"
click node_dataset "https://github.com/gundam-organization/gundam/blob/main/src/DatasetManager/include/DatasetDefinition.h"
click node_loader "https://github.com/gundam-organization/gundam/blob/main/src/DatasetManager/src/DataDispenser.cpp"
click node_samples "https://github.com/gundam-organization/gundam/blob/main/src/SamplesManager/src/SampleSet.cpp"
click node_params "https://github.com/gundam-organization/gundam/blob/main/src/ParametersManager/src/ParametersManager.cpp"
click node_dials "https://github.com/gundam-organization/gundam/blob/main/src/DialDictionary/DialEngine/src/DialManager.cpp"
click node_eventcache "https://github.com/gundam-organization/gundam/blob/main/src/DialDictionary/DialEngine/include/EventDialCache.h"
click node_propagator "https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/Propagator.cpp"
click node_cache "https://github.com/gundam-organization/gundam/blob/main/src/CacheManager/src/CacheManager.cpp"
click node_likelihood "https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/Likelihood/src/LikelihoodInterface.cpp"
click node_jointprob "https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/JointProbability/src/JointProbability.cpp"
click node_fitter "https://github.com/gundam-organization/gundam/blob/main/src/Fitter/Engine/src/FitterEngine.cpp"
click node_minimizer "https://github.com/gundam-organization/gundam/blob/main/src/Fitter/Minimizer/src/RootMinimizer.cpp"
click node_scanner "https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/Likelihood/src/ParameterScanner.cpp"
click node_plots "https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/PlotGenerator.cpp"
click node_eventwriter "https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/EventTreeWriter.cpp"
click node_python "https://github.com/gundam-organization/gundam/blob/main/src/PythonInterface/src/PythonInterface.cpp"

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,node_loader,node_samples toneBlue
class node_params,node_dials,node_eventcache toneAmber
class node_likelihood,node_jointprob,node_fitter,node_minimizer,node_scanner toneMint
class node_propagator,node_cache,node_plots,node_eventwriter toneRose
class node_config,node_python,node_analyst toneIndigo
```

## Components

### Inputs and samples

- [Dataset definition](https://github.com/gundam-organization/gundam/blob/main/src/DatasetManager/include/DatasetDefinition.h): `src/DatasetManager/include/DatasetDefinition.h`
- [Data dispenser](https://github.com/gundam-organization/gundam/blob/main/src/DatasetManager/src/DataDispenser.cpp): `src/DatasetManager/src/DataDispenser.cpp`
- [Sample set](https://github.com/gundam-organization/gundam/blob/main/src/SamplesManager/src/SampleSet.cpp): `src/SamplesManager/src/SampleSet.cpp`

### Fit model

- [Parameter manager](https://github.com/gundam-organization/gundam/blob/main/src/ParametersManager/src/ParametersManager.cpp): `src/ParametersManager/src/ParametersManager.cpp`
- [Dial engine](https://github.com/gundam-organization/gundam/blob/main/src/DialDictionary/DialEngine/src/DialManager.cpp): `src/DialDictionary/DialEngine/src/DialManager.cpp`
- [Event dial cache](https://github.com/gundam-organization/gundam/blob/main/src/DialDictionary/DialEngine/include/EventDialCache.h): `src/DialDictionary/DialEngine/include/EventDialCache.h`

### Statistical inference

- [Likelihood](https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/Likelihood/src/LikelihoodInterface.cpp): `src/StatisticalInference/Likelihood/src/LikelihoodInterface.cpp`
- [Joint probability](https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/JointProbability/src/JointProbability.cpp): `src/StatisticalInference/JointProbability/src/JointProbability.cpp`
- [Fitter engine](https://github.com/gundam-organization/gundam/blob/main/src/Fitter/Engine/src/FitterEngine.cpp): `src/Fitter/Engine/src/FitterEngine.cpp`
- [Minimizers](https://github.com/gundam-organization/gundam/blob/main/src/Fitter/Minimizer/src/RootMinimizer.cpp): `src/Fitter/Minimizer/src/RootMinimizer.cpp`
- [Parameter scanner](https://github.com/gundam-organization/gundam/blob/main/src/StatisticalInference/Likelihood/src/ParameterScanner.cpp): `src/StatisticalInference/Likelihood/src/ParameterScanner.cpp`

### Execution and results

- [Propagator](https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/Propagator.cpp): `src/Propagator/src/Propagator.cpp`
- [Weight cache](https://github.com/gundam-organization/gundam/blob/main/src/CacheManager/src/CacheManager.cpp): `src/CacheManager/src/CacheManager.cpp`
- [Plot generator](https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/PlotGenerator.cpp): `src/Propagator/src/PlotGenerator.cpp`
- [Event tree writer](https://github.com/gundam-organization/gundam/blob/main/src/Propagator/src/EventTreeWriter.cpp): `src/Propagator/src/EventTreeWriter.cpp`

### User interfaces

- [Config utilities](https://github.com/gundam-organization/gundam/blob/main/src/Utils/src/ConfigUtils.cpp): `src/Utils/src/ConfigUtils.cpp`
- [Python interface](https://github.com/gundam-organization/gundam/blob/main/src/PythonInterface/src/PythonInterface.cpp): `src/PythonInterface/src/PythonInterface.cpp`

### Other components

- **Analyst**

## Connections

- Analyst → Config utilities: provides config (evidence: `README.md`)
- Config utilities → Dataset definition: configures
- Dataset definition → Data dispenser: owns dispensers (evidence: `src/DatasetManager/include/DatasetDefinition.h`)
- Data dispenser → Sample set: loads events
- Parameter manager → Dial engine: supplies parameters
- Dial engine → Event dial cache: builds event cache
- Propagator → Parameter manager: uses parameters
- Propagator → Sample set: reweights samples
- Propagator → Event dial cache: uses dial cache
- Weight cache → Sample set: updates samples (evidence: `src/CacheManager/src/CacheManager.cpp`)
- Weight cache → Event dial cache: updates weights (evidence: `src/CacheManager/src/CacheManager.cpp`)
- Likelihood → Propagator: evaluates model
- Likelihood → Joint probability: computes probability
- Fitter engine → Likelihood: fits likelihood
- Fitter engine → Minimizers: selects minimizer (evidence: `src/Fitter/Engine/src/FitterEngine.cpp`)
- Fitter engine → Weight cache: uses weight cache (evidence: `src/Fitter/Engine/src/FitterEngine.cpp`)
- Parameter scanner → Likelihood: scans parameters
- Likelihood → Plot generator: exposes plotting
- Likelihood → Event tree writer: exposes event output
- Analyst → Python interface: uses Python API
- Python interface → Fitter engine: accesses fitting (evidence: `src/PythonInterface/src/PythonInterface.cpp`)
- Python interface → Dataset definition: accesses datasets (evidence: `src/PythonInterface/src/PythonInterface.cpp`)
- Python interface → Parameter manager: accesses parameters (evidence: `src/PythonInterface/src/PythonInterface.cpp`)
