CLI Reference#

HydroModPy exposes two equivalent console entry points, hmp and hydromodpy. The documentation uses hmp for brevity. The surface is split into seven hierarchical families plus a set of flat top-level verbs kept for fast everyday use. Each leaf parser carries its own --help text, so the family pages below stay short and focus on intent rather than exhaustive flag tables.

Run hmp --help to discover the top-level layout, or hmp <family> --help to list the sub-actions of a family.

Families#

Operational reference#

Flat top-level verbs#

The following verbs sit directly under hmp and are not (yet) nested in a family. They cover the most common workflow loop and a few maintenance helpers: hmp run, hmp calibrate, hmp test, hmp report, hmp compare, hmp doctor, hmp install-binaries, hmp add, hmp import, hmp export, hmp export-package, hmp data, hmp display, and hmp index. The flat hmp index verb is kept for the global workspace index and will be folded into a family in a later interface iteration.