[workflow] WorkflowConfig

TOML section: [workflow]

Pydantic model: WorkflowConfig defined in hydromodpy.config.hydromodpy_config.

Source on GitHub

Workflow selector configuration.

Show fields: User User + Dev All

Fields

mode

str required user source

Workflow mode dispatched by hmp run.

"simulation"

Runs one forward simulation and persists solver outputs, catalog rows, and result stores.

"calibration"

Repeatedly proposes parameters, runs candidate simulations, and records the calibration history.

"overview"

Loads geographic and data context and renders review maps without running a solver.

"comparison"

Runs several child simulations from one shared base config and compares their observables.

"testbed"

Expands a case matrix, delegates each case to a runner, and collects evidence artifacts.

"site_selection"

Selects or rejects candidate catchments and produces an auditable HTML review report.

profile

bool | str default = False expert source

Profile the run with pyinstrument (honored by the hmp CLI; the –profile flag wins over this field). true writes <config>.profile.html next to the config; a string sets the HTML report path.

Starter TOML snippet

Click to expand a copy-pasteable [workflow] TOML skeleton

Copy this block into your project.toml and uncomment the lines you want to set. Sub-tables ([parent.subfield]) appear in the order Pydantic expects them.

[workflow]
# mode = ""  # REQUIRED

Entity-relationship diagram

Click to zoom and pan. Press Esc or click outside to close.