Reference
Documentation
Find the user guide, configuration reference, developer material, and answers to common questions.
User Guide
From installation to analysis output
The user guide introduces GUNDAM, covers installation, explains how to run the applications, and connects each workflow to the detailed configuration reference.
Configuration Reference
Describe every part of the job
Top-level configuration connects the fitter engine, likelihood interface, minimizer, samples, parameter sets, output behavior, and version requirements. Included YAML files allow each concern to remain independently reviewable.
| Top-level option | Role |
|---|---|
fitterEngineConfig | Configures the fitting engine and its components. |
minGundamVersion | Stops the job when the active GUNDAM version is too old for the configuration. |
outputFolder | Selects the directory where output is written. |
Applications
Tools for fitting and validation
Application-specific documentation should be read together with the configuration used for a study. Always match documentation to the installed GUNDAM tag, because command-line options and configuration fields can evolve between releases.
Version discipline: Record the exact release or commit SHA in analysis notes and generated artifacts. A configuration file alone does not fully identify the software environment.
For Developers
Build changes that others can reuse
Development takes place on focused branches and is reviewed through pull requests. New behavior should arrive with documentation, tests or validation material, and a clear explanation of any configuration changes.
FAQs
Common analysis questions
The FAQ collects practical guidance on installation, configuration, minimization, convergence, spline behavior, and diagnostic interpretation.
Resources