Update pumping station basin documentation
This commit is contained in:
10
README.md
10
README.md
@@ -1 +1,9 @@
|
||||
# rotating machine
|
||||
# pumpingStation
|
||||
|
||||
Wet-well basin model and pump orchestration node for EVOLV.
|
||||
|
||||
The detailed documentation lives in [`wiki/`](wiki/):
|
||||
|
||||
- [`wiki/functional-description.md`](wiki/functional-description.md) defines the shared basin model, pipe reference semantics, safety points, net-flow selection, and child registration behaviour.
|
||||
- [`wiki/modes/`](wiki/modes/) documents control-mode-specific behaviour such as the level-linear `startLevel` demand ramp.
|
||||
- [`wiki/diagrams/basin-model.drawio.svg`](wiki/diagrams/basin-model.drawio.svg) is the current source of truth for the generic basin model.
|
||||
|
||||
Reference in New Issue
Block a user