Files
pumpingStation/wiki
znetsixe 4637448c49 Add modes/ section with levelbased page as the template
Introduces the pattern: basin model is the shared canvas (mode-agnostic
physics); each control mode is its own page under wiki/modes/ plus a
demand-vs-level transfer-function diagram under wiki/diagrams/modes/.

- wiki/modes/README.md — index + per-mode page template (inputs,
  threshold policy, demand formula, edge cases, related)
- wiki/modes/levelbased.md — first worked example using the new naming
  convention (dryRunLevel / minLevel / startLevel / maxLevel /
  overflowLevel). Forward-looking — the code still uses the old names
  until the pending rename refactor.
- wiki/diagrams/modes/levelbased.drawio.svg — transfer-function plot
  (zones: STOP / DEAD ZONE / RAMP / SATURATE, safety trips outside the
  plot). Round-trippable via embedded drawio XML.
- functional-description.md — replaced the inline levelbased/manual
  subsection with a table pointing at the modes/ pages. Removed the
  old control-zones ASCII diagram reference (superseded by the
  per-mode transfer function).
- wiki/README.md — added Control modes entry + diagrams/modes/ pointer.

The remaining placeholder modes (flowbased, pressureBased,
percentageBased, powerBased, hybrid, manual) can each fill in the
template independently.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 15:45:01 +02:00
..

pumpingStation — Documentation

All docs and diagrams for this node live in this folder so they version-lock with the code they describe.

Pages

  • Functional Description — operator-facing reference derived from src/specificClass.js: basin model, net-flow selection, safety interlocks, registration topology.
  • Control modes — one page per control mode (levelbased, flowbased, …) describing how the mode uses the shared basin model to compute demand.

Diagrams

Editable draw.io sources live in diagrams/. See diagrams/README.md for the editing workflow — open .drawio files in draw.io, export to .drawio.svg, commit both.

The basin model is the shared canvas (diagrams/basin-model.drawio.svg); per-mode transfer-function diagrams live under diagrams/modes/.

Part of

This node is a git submodule of EVOLV. The EVOLV superproject has its own wiki/ with platform-level docs (architecture, concepts, shared manuals).