docs: describe the build-out, the cash flow and the event stream

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This commit is contained in:
Kjell Tore Guttormsen 2026-11-12 11:58:25 +01:00
commit 326b80d8d1
Signed by: ktg
SSH key fingerprint: SHA256:JakMjO6FTBBzN0Bhfj9saOoEjaFxlSdYuZQQpM/lF9Q
3 changed files with 30 additions and 9 deletions

View file

@ -26,12 +26,17 @@ carousel, Python code, and a Claude plugin (own repo, later).
- `src/tokenfabrikker/`: the code, run from `src/` without being installed. `ligninger.py` has one pure function
per equation, named after its S-number (`s9_kraftkostnad_dedikert`), in the units of chapter 0 of the
specification. `parametere.py` reads the frozen file (checksum, strict validation, unit conversion).
`fordelinger.py` and `trekninger.py` make the Monte Carlo draws. So far: chapters 1 to 3 plus S45 and S47; the
cash flow, build-out, power system and ownership forms are not coded yet.
`fordelinger.py` and `trekninger.py` make the Monte Carlo draws, `hendelser.py` the stream for yearly events.
`inndata.py` holds one set of values in the equations' units (`Inndata`; `fra_trekning` builds it for a draw).
`utbygging.py` (S22: start years, IT vintages, export stops), `kraftsystem.py` (S23 to S25, S38) and
`kontantstrom.py` (S26, S34, S35, S40, S45: `lag_plan`, `regn_program`) put the equations together over the
years. So far: chapters 1 to 6; business economics, ownership, scale, environment and verdicts are not coded yet.
- `data/trekninger.npy` and `data/trekninger.json`: the 10 000 draws of the 87 drawn quantities, in the parameter
file's units. Committed; every later computation reads them.
file's units. `data/aarshendelser.npy` and `.json`: one uniform number per draw and year 2028–2100 for the
export rule (own seed). Committed; every later computation reads them.
- `tests/`: unit tests per equation, the loader, the draws, and `test_fasit.py` (known answers from Argonne,
NOU 2026: 4, Epoch and NVE with the sources' own assumptions).
NOU 2026: 4, Epoch and NVE with the sources' own assumptions). Build-out, power system and cash flow are tested
on the made-up set of values in `tests/conftest.py`.
- `requirements.txt` (numpy, scipy) and `requirements-dev.txt` (pytest, ruff, mypy) pin exact versions;
`pyproject.toml` only configures the tools (ruff `ALL`, mypy strict).
@ -54,7 +59,7 @@ carousel, Python code, and a Claude plugin (own repo, later).
- **Known-answer tests:** nothing is tuned to make one pass. A miss stays in the suite as a strict `xfail` with
the measured deviation and the cause if known, and is reported in the review log.
- **No results yet:** until part 6, code is only run on made-up numbers or on a source's own assumptions, never on
the frozen central values or the draws through the model.
the frozen central values or the draws through the model. `regn_program` is only called with the made-up set.
- **Neutrality:** vendors and companies are data sources, cited neutrally, never recommended. Nothing here
advertises a business. "Business case" means profitability for Norway, not something for sale.
- **Sadhguru** is mentioned in exactly one sentence, as inspiration, in the report's foreword and in README; never
@ -69,6 +74,7 @@ carousel, Python code, and a Claude plugin (own repo, later).
- Checks: `.venv/bin/ruff check . && .venv/bin/ruff format --check . && .venv/bin/mypy`
- Draws: `PYTHONPATH=src .venv/bin/python -m tokenfabrikker.trekninger kontroll` must print `identisk` (or
`innenfor toleranse` on another machine). `lag` rewrites the file and is only run after a deviation from the freeze.
The same two commands exist for the event stream: `-m tokenfabrikker.hendelser kontroll`.
## Workflow
- Remote is Forgejo (`git.fromaitochitta.com`), never GitHub. Private under `ktg/` until the repo-standard gate is