Document Sud.derive_plant_params() in the README

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-06-19 19:36:31 +02:00
co-authored by Claude Sonnet 4.6
parent b6551c6433
commit 2dcf644bed
+5 -2
View File
@@ -128,8 +128,11 @@ environment (`$WORKON_HOME`/`$BREWPI_HOME`) on a Raspberry Pi-style deployment.
## Mash schedules ## Mash schedules
Files under `sude/` describe a brew's mash schedule ("Sud"): pot weight, Files under `sude/` describe a brew's mash schedule ("Sud"): `pot_mass`,
malt/water weights, and a flat `schedule` list of steps, each either: `pot_material`, `grain_mass`, `water_mass` (used by `Sud.derive_plant_params()`
to compute a lumped thermal mass/specific-heat pair for `Pot`'s `M`/`C`, e.g.
in `scripts/demos/sud/demo_sud.py`, instead of hand-tuning them), and a flat
`schedule` list of steps, each either:
- `"type": "heat"` — ramp to `temp` at `rate` (°C/min), or - `"type": "heat"` — ramp to `temp` at `rate` (°C/min), or
- `"type": "hold"` — hold the current target for `duration` seconds (omit - `"type": "hold"` — hold the current target for `duration` seconds (omit