Per-Package Reference#
One focused page per top-level subpackage of hydromodpy/. Each
page covers:
the package role (what question it answers);
the sub-modules and their responsibilities;
the key public symbols a contributor needs to know;
the recommended reading path inside the code;
the layer-matrix neighbours and the documented tolerances.
For high-level questions (mental model, layer matrix, design patterns), see Architecture and Developer Guide and the foundation pages listed there.
For prescriptive questions (“how do I add X”), see How-to Recipes.
Subpackages#
Kernel leaf: units, Profile, workspace, metrics, I/O, runtime
state, input-file tracking.
Root HydroModPyConfig Pydantic model that aggregates every
TOML section.
Process layer: ProcessSpatial, Flow, Transport,
forcing bridge, hydrology helpers.
17 variables, source registry, planner, DuckDB cache.
Delineation, geographic context, domain, mesh (Cartesian and
Gmsh), field abstractions, HydroMesh pivot.
Neutral numerical discretization primitives, currently temporal grids and time-mesh configuration.
Backend abstraction plus three concrete backends: MODFLOW 6, MODFLOW-NWT, Boussinesq.
Planner, runner, extraction post-run, simulation-side adapters.
Ask/tell engine, parameter sets, objective dispatch, optimizer adapters.
Workspace catalog, Run facade, importers, exporters.
V1 facade over the three DuckDB scopes (cache, project, index) and the T6.B mutator surface.
33 named figures registered through a single catalog, plus shared static HTML block primitives.
Cross-run analysis: simulation comparison and testbed variants (including the regional_lab profile).
HTML composites: calibration session report, comparison web report, streamlit configurator, and guidance for block-based workflow reports.
Composable steps and the immutable PipelineState payload.
Public Project facade and dispatch adapters above the
workflow layer.
Experimental observability island, isolated from the modeling layers.
JSON Schema export and partial-field validator for frontends.
hmp and hydromodpy console entry points; one verb per
module under cli/commands/.