Files
pumpingStation/wiki
Rene De Ren 6ab585bcc2 Docs + simulations refresh; align spill-flow keys with new position
- wiki/functional-description.md: rename Overfill Protection → High-volume
  Safety; tighten basin-ordering chain; relocate level-based mode
  diagrams under wiki/diagrams/modes/level-based/; document the new
  flow.predicted.overflow.default position (replaces the previous
  child='overflow' under position 'out'); add underflowVolume +
  predictedUnderflowVolume entries.
- wiki/modes/{levelbased,powerbased}.md: paragraph cleanups.
- wiki/diagrams: move level-linear basin diagram under modes/level-based/
  alongside a new level-log variant.
- simulations/run.js: add max_demand_gt expectation.
- simulations/scenarios/*: minor fixture updates.
- test/basic/nodeClass-config.test.js: new config-shape coverage.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 17:23:20 +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 SVGs live in diagrams/. See diagrams/README.md for the editing workflow — open the .drawio.svg in draw.io, edit it, then export back to SVG with the source embedded.

The basin model is the shared physical canvas (diagrams/basin-model.drawio.svg); per-mode transfer-function diagrams live under diagrams/modes/. Mode-specific thresholds such as startLevel belong in those mode diagrams, not in the generic basin model.

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).