documentation¶
Documentation for the Bayesian beam theory model selection framework.
contents¶
| document | description |
|---|---|
| getting started | installation and first run |
| architecture | system design, components, data flow |
| technical spec | full design rationale, formulas, and sequence diagrams |
| API reference | class and function documentation |
| development guide | dev environment, testing, debugging |
| parameters | parameter tables, priors, sign conventions |
| bayesian glossary | glossary of all statistical methods used |
root-level docs¶
| document | description |
|---|---|
| README | project overview and quick start |
| contributing | contribution guidelines |
| changelog | version history |
| authors | developers and acknowledgments |
Structure¶
docs/
README.md this file
getting-started.md installation, first run, troubleshooting
architecture.md system design, Mermaid diagrams, design decisions
technical-spec.md full design rationale, LaTeX formulas, sequence diagrams
api-reference.md every public function and class
parameters.md parameter tables, priors, sign conventions, study grid
bayesian-glossary.md all 22 statistical concepts with code locations
development-guide.md testing, linting, debugging, extension patterns