Python API

HydroModPy exposes its top-level verbs through import hydromodpy as hmp. Each verb mirrors a CLI subcommand so hmp.run("cfg.toml") and hmp run cfg.toml execute the same workflow. The functions are re-exported from hydromodpy._api.

Catalog and indexing

• hydromodpy.open() – the single door to a workspace catalog (object access, DataFrames, and schema discovery). Replaces the former open_catalog.

• hydromodpy.index() – open the machine-wide global index of workspaces.

Workflow launchers

• hydromodpy.run() – run any workflow from a TOML file or config object; dispatches on [workflow] mode (simulation, overview, comparison, mesh, testbed).

• hydromodpy.calibrate() – run a calibration workflow.

Analysis and reporting

• hydromodpy.compare_pair() – compare two simulations by id.

• hydromodpy.report() – render the HTML calibration report.

• hydromodpy.read() – read a variable from a simulation Run with auto-dispatch.

Diagnostics

• hydromodpy.doctor() – lightweight environment diagnostic.

Verbs

• hmp.open
• hmp.index
• hmp.run
• hmp.calibrate
• hmp.compare_pair
• hmp.report
• hmp.read
• hmp.doctor