Rischio
Start free

DocsOpen channels

Inputs

Every field a model of an open channel takes, as the engine's schema gives it: what it is, its unit and convention, and its limits.

A model is a JSON document, the same one the studio’s forms build, its AI writes and an agent sends with create_model. Its section has an id, stable and unique in the model (the results name by it the element each check depends on), and a name, shown on the canvas and in the report. Every model states its contract_version, today 2. Units are SI: m, m², m³/s and m/s; the slope is a ratio, m/m.

These are its fields, from the engine’s own schema: what the studio’s forms are built from, and what get_tool_schema gives an agent.

sectiongroup · required

pointslist · required · at least 3

The cross-section from one bank to the other: the first and last points are the banks, both higher than the bed.

Each item:

xnumber · required

Horizontal position (m), never smaller than the previous point's.

znumber · required

Elevation (m).

roughnesslist · required

Manning's n of each segment: roughness[i] goes from points[i] to points[i + 1], so one fewer than the points.

slopenumber · required · > 0

Longitudinal slope (m/m): 0.002 is 0.2 %.

dischargenumber · required · > 0

Discharge Q (m³/s).

Type to search: a method, a warning, a field…

↑↓ to move · ↵ to open · esc to close