Common setter patterns
Value inputs, broadcasting, read-only fields, references, and stale results.
Open sectionSetting Parameters
Setter paths follow m.set.<main_category>.<sub_category>(value, ids=None). They edit writable model inputs in memory and mark results stale when a model already has output loaded.
m.set.conduit.roughness(0.013)
m.set.conduit.roughness([0.013, 0.014], ids=["P001", "P005"])
m.set.node.tag("inspection-needed", ids=["J1", "J2"])Behavior
| Input | Behavior |
|---|---|
| Scalar | Broadcast across selected IDs. |
| List/array | Length must match selected objects. |
| pandas Series/DataFrame | Accepted for supported structured fields such as point or sequence data. |
| Read-only field | Derived and result variables raise ReadOnlyParameterError. |
| Invalid reference | Reference setters validate target IDs where the schema defines a relationship. |
Detailed Setter Reference
The full setter notebook is divided into focused pages by model domain.
Model options
General, process, date/time, and dynamic-wave option setters.
Open sectionClimate and hydrology
Climate, rainfall, subcatchment, infiltration, and LID-related setters.
Open sectionNodes
Composite node setters and detailed junction, outfall, divider, and storage-unit fields.
Open sectionLinks
Composite link setters plus conduit, pump, orifice, weir, outlet, and cross-section fields.
Open sectionHydraulic geometry and water quality
Inlets, streets, transects, pollutants, land use, buildup, washoff, and treatment.
Open sectionTime, map data, summaries, and results
Curves, time series, inflows, controls, coordinates, and read-only summary/result surfaces.
Open section