hydromodpy.results.derived

Pure-function derivations of secondary fields from primary outputs.

The functions here turn primary fields (head, surface elevation, drain budget) into the quantities needed by figures and exports - water-table elevation, depth, seepage masks, fluxes. They never read the catalog directly: callers pass in numpy or xarray arrays and receive arrays back.

This keeps display code free of physics: a figure asks for a derived field already computed; the catalog or the extractor is responsible for invoking these helpers when ingesting solver output.

Functions

fluxes_from_budget(component_field, cell_area)	Convert a per-cell budget flux (m³/d) into a unit flux (m/d).
seepage_mask(head, top)	Boolean cells where the water table reaches or exceeds the surface.
watertable_depth(head, top)	Depth from surface to water table, clipped to ≥ 0.
watertable_elevation(head, top)	Water-table elevation - head at the uppermost saturated layer.