[observation] ObservationConfig

TOML section: [observation]

Pydantic model: ObservationConfig defined in hydromodpy.simulation.planning.observation_config.

Source on GitHub

Configuration for [observation]: points sampled during the run.

Example

[observation]
variables = ["head", "watertable_depth"]

[[observation.points]]
id = "piezo_amont"
x = 395100.0
y = 6824925.0
depth = 12.5

Show fields: User User + Dev All

Fields

points in TOML: [[observation.points]]

list[ObservationPointConfig] factory user source

Observation points sampled once the run has produced its fields.

Fields of ObservationPointConfig

id

str required user source

Station id of the point. Unique within the section.

x

float required user source

Easting in the project CRS (same units as the mesh).

y

float required user source

Northing in the project CRS (same units as the mesh).

layer

int | None default = None user source

Zero-based layer index to read. Mutually exclusive with ‘depth’.

depth

float | None default = None user source

Depth in metres below the local model top; picks the layer from the mesh layer thicknesses. Mutually exclusive with ‘layer’.

variables

list[str] | None default = None user source

Variables sampled at this point. Defaults to the section-level ‘variables’ list.

variables

list[str] factory user source

Variables sampled at every point that does not name its own. Virtual fields (watertable_depth, seepage_mask …) are accepted.

Starter TOML snippet

Click to expand a copy-pasteable [observation] TOML skeleton

Copy this block into your project.toml and uncomment the lines you want to set. Sub-tables ([parent.subfield]) appear in the order Pydantic expects them.

[observation]
# variables = ...  # uses factory default

[[observation.points]]
# id = ""  # REQUIRED
# x = 0.0  # REQUIRED
# y = 0.0  # REQUIRED
# layer = ...  # default = None
# depth = ...  # default = None
# variables = ...  # default = None

Entity-relationship diagram

Click to zoom and pan. Press Esc or click outside to close.