Skip to content

docs: align prose with current implementation - #36

Merged
koen-vg merged 1 commit into
Sustainable-Solutions-Lab:mainfrom
koen-vg:chore/audit-stale-prose
Jul 28, 2026
Merged

koen-vg merged 1 commit into
Sustainable-Solutions-Lab:mainfrom
koen-vg:chore/audit-stale-prose

Conversation

@koen-vg

@koen-vg koen-vg commented Jul 28, 2026

Copy link
Copy Markdown
Member

Summary

  • Align documentation, docstrings, comments, and configuration prose with the current implementation.
  • Remove historical implementation wording and unnecessary detail from the audited paths.
  • Remove the unused restricted-data validator and an unused plotting compatibility alias.
  • Simplify a redundant scenario-configuration branch.

Validation

  • pixi run -e dev docs-local
  • pixi run -e dev lint
  • pixi run -e dev pytest -q tests/test_extract_health_impacts.py tests/test_compute_gleam3_feed_fractions.py tests/test_sensitivity.py tests/test_manure_emissions.py (90 passed)
  • Commit hooks: Ruff, snakefmt, REUSE, and Furo directive checks

@koen-vg
koen-vg force-pushed the chore/audit-stale-prose branch from 927da96 to a233fef Compare July 28, 2026 20:51
@koen-vg
koen-vg marked this pull request as ready for review July 28, 2026 20:54
@koen-vg
koen-vg merged commit b1b82c1 into Sustainable-Solutions-Lab:main Jul 28, 2026
4 checks passed
@koen-vg
koen-vg deleted the chore/audit-stale-prose branch July 28, 2026 20:55
koen-vg added a commit that referenced this pull request Jul 28, 2026
The feed, food_waste, food_demand and cost steps all read
`deviation_penalty.yaml`, which the stability step writes at the end of the
chain. The chain is a strict forward pass, so those four were fit against
whatever vintage happened to be on disk, and `tools/calibrate --check`
reported them stale after every complete run.

None of them needs the file. feed, food_waste and food_demand pin production
to actuals via `use_actual_production` and the enforced baselines, so the
deviation penalty has nothing to act on; they now disable it. The cost step
drives production stability through hard bounds, and the solve resolves the
`"calibrated"` sentinel only for an enabled L1 penalty -- the input
declaration in `calibration_artefact_inputs` now mirrors that gate instead of
keying off the sentinel alone, which drops the dependency there without a
config change.

The dependency was inert: regenerating both tracked sets against the current
model reproduces every artefact byte-identically, and `--check` now settles
all-green after a full chain.

Also re-stamps both sets after #36 and #38. Neither moved the artefacts --
verified by a full re-run, not by inspection.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant