Configuration overview#
Card-based map of every TOML section validated by HydroModPyConfig.
Click a card to open the section detail page.
Companion pages
Configuration index – flat global index, Ctrl+F friendly
Complete annotated TOML reference – full annotated TOML reference
Schema Explorer – interactive JSON Schema viewer
Recipes – task-oriented cookbook
Quick search across every TOML path#
Sections#
[workflow]
Workflow configuration. workflow.mode must be one of ‘simulation’, ‘calibration’, ‘overview’, ‘comparison’, ‘testbed’, ‘site_selection’. Drives dispatch in hmp run <toml> and in API-driven callers that instantiate HydroModPyConfig from a frontend form.
[workspace]
Configuration block for the project workspace and folder structure.
[geographic]
Configuration block for geographic and watershed delineation parameters.
[domain]
Domain configuration defining domain depth plus the spatial-support mode used for heterogeneous parameter mapping (none, geology, or zones).
[data]
Data-managers configuration. Use data.types to declare requested families (for example geology). The launcher can also infer extra families from other sections (domain, flow), controlled by data.inference_mode (‘warn’ or ‘strict’).
[flow]
Flow process configuration with declared parameter ids in [flow].param_list and payloads validated from [flow.param.<id>] TOML sections.
[transport]
Transport process configuration, with solver-specific parameter blocks under [transport.modpath.parameters], [transport.mt3dms.parameters], and [transport.modflow6gwt.parameters].
[simulation]
Optional simulation orchestration block loaded from [simulation] and [[simulation.process]]. When absent, the launcher uses its default fixed phase order.
[solver]
Global solver block loaded from [solver]: the backend selector in [solver.backend], plus the backend-agnostic preprocessing switches both MODFLOW backends read (solver.sink_fill, solver.drain_band_depth_m).
[modflownwt]
Expert MODFLOW-NWT package configuration loaded from [modflownwt.runtime.<package>], [modflownwt.process_specific], [modflownwt.sgrid.planar], and [modflownwt.sgrid.vertical].
[modflow6]
Expert MODFLOW 6 package configuration loaded from [modflow6.runtime], [modflow6.process_specific], [modflow6.sgrid.planar], and [modflow6.sgrid.vertical].
[display]
Optional display and export toggles loaded from the [display] section.
[export]
Automated export configuration loaded from the top-level [export] section. Controls which formats (CSV time series, GeoTIFF, NetCDF, VTU, shapefile), which variables and timesteps are written after a run, and whether a portable ‘.hmp’ archive is produced.
[persistence]
Storage backend toggles loaded from [persistence]. Drives the DuckDB catalog, Zarr field arrays, Parquet tables, and the hydromodpy.lock reproducibility manifest.
[observation]
Observation points declared in [observation] and sampled while the run still holds its fields. Each [[observation.points]] entry names a location (x, y, and layer or depth); its series land in the run timeseries table, so no post-hoc interrogation is needed for a point known in advance.
[analysis]
Optional analysis hub loaded from [analysis]. Aggregates [analysis.capability_gallery] (figure publication), and [analysis.comparison] (simulation-comparison launcher).
[overview]
Optional overview report settings loaded from the [overview] section. When present without [simulation], triggers the data-overview (watershed identity card) workflow.
[mesh_catchment]
Optional mesh-only settings loaded from the [mesh_catchment] section. Mesh-only public runs should use [simulation.process] with type=’mesh’; the standalone mesh API can still consume this section directly.
[mesh_input]
Optional external mesh declaration loaded from the [mesh_input] section. Declares a pre-existing planar mesh (and optional solver exchange bundle) the simulation or comparison workflow should consume instead of running the embedded mesh-catchment workflow. Mutually exclusive with [mesh_catchment].
[calibration]
Optional calibration settings loaded from the [calibration] section. When present, triggers the calibration workflow.
[spinup]
Optional cyclic spin-up settings loaded from the [spinup] section. Drives ‘hmp spinup’: repeat a forcing window, restart each cycle from the previous state, until the heads and the lake stage converge.
[testbed]
Optional method-testbed settings loaded from the [testbed] section. Drives the orchestration layer over child runners (comparison or simulation) and is dispatched when workflow.mode=’testbed’.
[site_selection]
Optional upstream basin site-selection workflow configuration.
[hydrometry]
Optional hydrometric observations used by data and site-selection workflows.