User guide
Start with your first run if you have not built the package.
These guides assume an application that can load the worker and WASM assets, or
Node.js 22 or later for worker_threads execution.
Build and run
| Task | Guide |
|---|---|
| Open a model, inspect IDs, and edit declarations | Inspect and configure a model |
| Advance, pause, resume, and finalize | Run a model |
| Configure browser hosting and UI progress | Integrate with a frontend |
| Choose batch, interactive, manual, or scenario workflows | Choose a run workflow |
Observe and control
| Task | Guide |
|---|---|
| Sample hydraulic, runoff, and quality values | Collect results, quality, and statistics |
| Read per-object and system statistics | Collect results, quality, and statistics |
| Supply uploads or Node byte inputs and save files | Load files and download output |
| Query finalized or incomplete binary output | Read binary output |
| Apply hydraulic, rainfall, pollutant, or catchment controls | Runtime forcings |
| Continue or branch a run | Hotstarts, checkpoints, and forks |
Understand the API
- Lifecycle and ownership: valid states, finalization, cooperative termination, reset, sleep, and continuation mechanisms.
- Handles, records, and snapshots: what stays owner-bound and what is copied.
- Units and time: project units, calendar strings, seconds, and cadence.
- Errors and recovery: validation, solver failures, and cleanup.
For signatures and every exposed record field, use the API reference.