Quickstart¶
The fastest accurate path to the current HydroSwarm v0.2.1 release and frozen HydroCore-v5 runtime.
Docker: published release (recommended)¶
git clone https://github.com/insightlabs38-pixel/HydroSwarm.git
cd HydroSwarm
docker compose -f docker-compose.release.yml up
Open http://127.0.0.1:8765.
This pulls the published, tested multiarch v0.2.1 image (ghcr.io/insightlabs38-pixel/hydroswarm:v0.2.1) directly rather than building locally.
Docker: build from this checkout¶
docker compose build
docker compose up
Open http://127.0.0.1:8765.
This builds the current Dockerfile, includes the frozen V5 bundle, runs the strict V5 readiness check during the build, and launches the V5-default API. Useful when reviewing an uncommitted or in-progress change rather than the tagged release.
Native¶
For a fresh source checkout, native setup requires 64-bit Python 3.12+ and Node.js 22+. See Installation for exact platform prerequisites, including the additional Linux ARM64 EPANET build tools.
Linux:
./setup_hydroswarm_linux.sh
./start_hydroswarm_linux.sh
macOS and Windows have matching _macos.sh and _windows.ps1 scripts. Native macOS support is Apple Silicon/ARM64 only; native macOS Intel/x86_64 is not supported (no upstream torch>=2.5 wheel exists for it). Native Windows support is x86_64.
The setup scripts finish with the strict application self-test, verifying the frozen V5 release bundle throughout.
Verify the model that will serve¶
hydroswarm self-test --strict
The frozen V5 model SHA-256 is:
de2b3f56243a1933d1d7c5957cd74a29fade119f7d104ce7f1500b3dd7b6d2a5
Exact identity: Final system.
What to open first¶
On first launch:
- Run Reference Incident — deterministic checksummed replay of the frozen golden workflow. It demonstrates workflow/authority, not final V5 benchmark performance.
- Run Live Example — executes the frozen
v0.2.1runtime against the same bundled scenario inputs. Its governed result may differ from the Reference Incident because Reference is a frozen replay, not live V5 recomputation; the current bundled example reaches a governed abstention. - Import Your Own Network — advanced path for a local EPANET
.inp. - Illustrative fallback — clearly labeled hand-authored fallback.
For final V5 evidence, do not infer performance from the demo. Read Scientific evidence.
How to read a result¶
- Check provenance/model hash.
- Check calibration applicability and OOD state.
- Treat the learned source/event/evidence outputs as advisory.
- Treat Scout/planning decisions as deterministic governed controls.
- Require exact WNTR/EPANET verification for
VERIFIED. - Require a separate human event for
APPROVED. - Remember that approval records a decision; HydroSwarm does not actuate infrastructure.
Problems?¶
Run:
hydroswarm self-test --human --strict
Then consult Operator guide and Limitations.