Python API reference
Start with Simulation, then follow the references for the
objects you need. Collections expose configured model data, snapshots keep
results from one solver instant, and OutputReader reads binary
output after routing stops. The tables and signatures below provide the exact
names when memory supplies something plausible but wrong.
| Area | Reference |
|---|---|
| Project lifecycle and top-level access | Simulation |
| Binary metadata and result series | Binary output |
| Numerical and analysis policy | Simulation options |
| Nodes, links, subcatchments, rain gages, LIDs, and RDII | Object collections, object-family pages, and RDII objects |
| Curves, patterns, pollutants, controls, and related definitions | Model definitions |
| Current and cumulative owned records | Snapshots and statistics and Collect results and statistics |
| Typed values and failures | Enums and exceptions |
| Package and embedded solver identity | Package metadata |
All hydraulic and quality values preserve the model's configured units. Lifecycle restrictions documented on properties and methods are part of the API contract. Supported top-level imports include Simulation, SimulationState, SolverErrorCode, and the exception/diagnostic types documented in Exceptions.