API Reference#

The API reference is generated automatically from docstrings via autosummary :recursive:. Every public subpackage is walked top-down and each public class, function, and module gets its own page under api/generated/.

Top-level facade functions live under hydromodpy. The Pydantic configuration root lives under hydromodpy.config. Domain layers (data, solver, calibration, …) follow the architecture matrix documented in Architecture and Developer Guide.

Public facade#

The single supported import path is import hydromodpy as hmp. The V1 facade re-exports the verbs and helpers below from hydromodpy._api. For the structural contracts and the field registry, see Protocols and public contracts.

hydromodpy.open

Open a HydroModPy project catalog.

hydromodpy.read

Read a variable from a simulation Run with storage-kind auto-dispatch.

hydromodpy.export

Export a variable from a simulation to a standalone file.

hydromodpy.run

Run a HydroModPy workflow from Python.

hydromodpy.calibrate

Run a calibration workflow from a TOML file or config object.

hydromodpy.index

Open the machine-wide global index that federates registered workspaces.

hydromodpy.compare_pair

Compare two simulations by id or result object.

hydromodpy.report

Render the HTML report for a calibration session.

hydromodpy.audit_prune

Apply retention_policies to audit_log for the workspace catalog.

hydromodpy.bootstrap_proj

Configure PROJ environment variables for the active interpreter.

hydromodpy.doctor

Lightweight environment diagnostic.

Public subpackages#

These subpackages expose stable, user-facing APIs (configuration root, project catalog, run facade, display registry, calibration helpers). Their listings are recursive: every public class, function, and submodule gets its own generated page.

hydromodpy.config

Application-level configuration API.

hydromodpy.results

Result storage for HydroModPy simulations (DuckDB + Zarr).

hydromodpy.display

Solver-agnostic figure rendering for HydroModPy simulations.

hydromodpy.calibration

Calibration sub-system.

hydromodpy.catalog

hmp.catalog -- input-data cache view for a workspace.

hydromodpy.project

Public Project facade and its helper subsystems.

Internal subpackages#

These subpackages are exposed for contributors extending HydroModPy. They follow the strict layered architecture documented in Architecture and Developer Guide. Listings are not recursive; click through to a module to read its direct members.

hydromodpy.analysis

Analysis layer for HydroModPy.

hydromodpy.core

Core infrastructure layer for HydroModPy.

hydromodpy.data

Public API for HydroModPy data loading and planning.

hydromodpy.discretization

Discretization primitives shared by solver backends.

hydromodpy.physics

Public process namespace.

hydromodpy.reporting

Reporting layer for HydroModPy.

hydromodpy.schema

Frontend hooks: JSON Schema export + partial field validator.

hydromodpy.simulation

Simulation orchestration models and planning helpers.

hydromodpy.solver

hydromodpy.spatial

Spatial layer for HydroModPy.

hydromodpy.workflow

Composable workflow layer for HydroModPy simulation pipelines.

Docstring policy#