Model reference
Inputs, conventions, and the generated API docs.
This page indexes the authoritative reference material, which lives in the engine repository. Nothing here restates a number the engine does not pin.
Conventions
The engine documents its own conventions in docs/06-conventions.md. The ones that most affect how results are read:
- Total-generation demand convention (D3). Underlying demand is National Demand plus NESO’s half-hourly embedded-generation estimate, and embedded capacity is modelled explicitly. A consequence, stated plainly: solar validation is partly circular on the NESO embedded estimate.
- Interconnector sourcing. GB↔︎FR and GB↔︎BE physical flows are sourced from Elexon / NESO, never ENTSO-E — the same discipline the reproduction data follows (see Reproducibility & data).
- Output headers. Every run output embeds the determinism triple and the per-file data-pack checksums it consumed.
Scenario files
Scenarios are TOML. The reference set lives under scenarios/ in the engine repo; investigation scenarios live under investigations/<slug>/ at a pinned engine tag and double as CI regression fixtures.
| Scenario | File | Reproduction tier |
|---|---|---|
| 2024 GB reference | scenarios/gb-2024-reference.toml |
GB — open data pack |
| Royal Society 37-year | scenarios/royal-society-37y*.toml |
GB — open data pack |
| FES 2025 pathways | scenarios/fes2025-ee-*.toml |
GB — open data pack |
| CCC CB7 pathways | scenarios/ccc-cb7-bp-*.toml |
GB — open data pack |
| 5-zone / 8-zone continental | scenarios/gb-2024-5zone.toml, …-8zone.toml |
Continental — bring your own ENTSO-E token |
The “continental-tier” scenarios depend on ENTSO-E-derived data that cannot be redistributed; their reproduction path is documented under Reproducibility & data.
API reference
The generated Rust API documentation (cargo doc --no-deps) is published at /api/, built and version-pinned by the engine’s CI.
/api/ is not wired on this scaffold. The prose above cross-links to it as the launch target.