CLI reference#

HydroModPy exposes two equivalent console entry points, hmp and hydromodpy. The documentation uses hmp for brevity. This section is the authoritative command inventory.

hmp --help              # top-level verbs
hmp <family> --help     # sub-actions of one family
hmp <family> <action> --help

Every leaf parser carries its own --help, so the pages below focus on intent rather than exhaustive flag tables.

Command inventory#

Eleven families group their own sub-actions; six verbs sit directly under hmp.

Family	Sub-actions
hmp workspace	`init`, `list`, `register`, `search`, `forget`, `prune`, `clean`
hmp project	`new`, `list`, `show`, `delete`
hmp catalog	`ls`, `query`, `show`, `point`, `gc`, `reindex`, `delete`, `restore`, `trash`, `tag`, `note`, `rename`, `diff`, `watch`, `export`, `import`, `rerun`
`hmp data`	`ls`, `get`, `check`, `add`, `remove`, `prune`, `archive`, `restore`, `export`, `export-package`, `import`
hmp viz	`list`, `show`, `gallery`
`hmp config`	`template`, `check`, `schema`, `wizard`
hmp dev	`run-script`, `completion`, `schema`, `lock`, `rank`, `manage`
hmp audit	`list`, `verify`
hmp privacy	`purge`, `verify`
`hmp site-selection`	`plan`, `select-catchments`, `build-observed`, `build-generated`, `report`
`hmp report`	`render`, `compare`, `catchment`

Flat verb	Role
hmp run	Run a workflow from a TOML config.
hmp calibrate	Run a calibration workflow from a TOML config.
hmp spinup	Cyclic spin-up: restart each cycle until heads and lake stage converge.
`hmp test`	Run unit, regression or validation test subsets.
`hmp doctor`	Diagnose the environment: Python, dependencies, solver binaries, workspace resolution, index-versus-disk consistency.
`hmp install-binaries`	Download MODFLOW, MODPATH and MT3D-USGS binaries into the managed cache.

Addressing a run#

Every command that takes a run accepts the same reference grammar: the run name (cheze_baseline), a versioned name (cheze_baseline.v3), a unique id prefix (9c41aa02), the full id, or a selector. Selectors are @last, @last~N, @best:METRIC, @worst:METRIC and @running. A bare name resolves to the latest version of that stem.

Families#

Operational reference#