Technical appendix¶
The technical appendix documents the methods behind the toolbox: the equations, the timing conventions and the algorithms that these pages describe in words.
It lives in the repository folder
docs/technical_appendix/.
Other design documents in the repository¶
| Document | Content |
|---|---|
docs/USER_GUIDE.md |
The full user guide: every option with its checks, worked examples, outputs, practical notes |
docs/DESIGN.md |
Design specification: package contract, generator, expectations, engine, outputs, extensions |
docs/DESIGN_br_extensions.md |
Design of the agent types, shares over N types, forecast transforms, the generalised anchor and the Kalman history |
docs/FEATURES.md |
Feature register: what is configurable and where it is set |
README_PIPELINE.md |
The project's pipeline map and status |