hmp dev

The hmp dev family groups developer-only commands: shell completion, schema export, lockfile management, configuration tooling, ranking, and the prototype script runner. Stability is best-effort; flags can change between minor releases.

run-script

Synopsis: hmp dev run-script <path> [-- <script_args>...]

Execute a Python prototype script outside the stable hmp run contract. Forwards every argument after -- to the script untouched. Useful for one-off experiments that do not warrant a TOML.

Example:

hmp dev run-script tools/inspect_zarr.py -- --sim 1a2b3c4d

completion

Synopsis: hmp dev completion {bash|zsh|fish}

Emit a shell completion script on stdout. See Shell completion for the installation snippets.

schema

Synopsis: hmp dev schema {export|validate-field} [...]

Export the JSON Schema for HydroModPyConfig (consumed by the Streamlit UI and any frontend hook) or validate a single field value against its declared type. The exported schema is the canonical contract between the Python core and external tooling.

lock

Synopsis: hmp dev lock {update|archive|restore|verify}

Manage the reproducible data lockfile (hydromodpy.lock). update rescans the cache, archive snapshots the current lock, restore reverts to an archived snapshot, verify checks the recorded hashes against the on-disk artefacts.

config

Synopsis: hmp dev config {template|check|schema|wizard} [...]

TOML configuration tooling: generate a starter template, validate a TOML against the Pydantic schema, export the JSON Schema (alias of hmp dev schema export), or open the stdin-driven wizard.

rank

Synopsis: hmp dev rank <project> [--metric <name>] [--top <n>]

Rank the simulations of a project by a metric (default: nse) and print the top or bottom N rows. Quick way to spot the best calibration candidate before reading the full report.

manage

Synopsis: hmp dev manage [--port <port>]

Launch a local browser UI for workspace inspection and cleanup. Kept as-is from the legacy interface; will be folded into hmp viz during a later iteration.