Figure Catalog#

Figures live in hydromodpy.display and consume the persisted hydromodpy.results.run.Run interface. They are solver-agnostic: the same figure name can render MODFLOW-NWT, MODFLOW 6, or Boussinesq outputs when the required result fields exist.

Basic usage#

from hydromodpy.display import get, list_figures

list_figures()
get("piezometric_map").plot(run, save_path="head.png")

From the CLI:

hmp viz show <sim_id> <figure>
hmp viz gallery project.toml
hmp run project.toml --no-display

Registered figure names#

The catalog below is auto-generated from the hydromodpy.display.list_figures() registry. Each entry shows the figure name, the title rendered in plots, and the result fields or tables the figure reads at render time. Run python -m tools.doc_figures to refresh the partial without rebuilding the rest of the documentation; the Sphinx build also regenerates it on every run.

Spatial maps#

Mesh- or raster-backed scalar maps of one persisted field.

Figure name	Title	Required inputs
`concentration_map`	Concentration	fields `concentration`
`piezometric_map`	Water-table elevation	fields `watertable_elevation`
`recharge_map`	Recharge map	fields `recharge`
`seepage_map`	Seepage areas	fields `seepage_mask`
`simulated_active_network`	Simulated active network	fields `accumulation_flux`

Cross-sections#

Vertical or transverse cuts through a persisted field.

Figure name	Title	Required inputs
`cross_section`	Head cross-section	fields `head`

Time series#

Chronicles read from the catalog timeseries table.

Figure name	Title	Required inputs
`calibration_convergence`	Calibration convergence	tables `calibration_iterations`
`calibration_trace`	Calibration parameter trace	tables `calibration_iterations`
`duration_curve`	Flow-duration curve	tables `timeseries`
`hydrograph`	Discharge hydrograph	tables `timeseries`
`recession`	Recession analysis	tables `timeseries`
`seasonal_boxplot`	Seasonal box-plot	tables `timeseries`

Budgets and balances#

Integrated budget or mass-balance summaries.

Figure name	Title	Required inputs
`water_budget`	Water budget	tables `budgets`

Particle tracking#

Pathline or particle-track outputs.

Figure name	Title	Required inputs
`particle_tracks`	Particle pathlines	fields `particles`

Comparisons and overlays#

Multi-panel views combining one or several runs, observed data, or calibration traces.

Figure name	Title	Required inputs
`calibration_landscape`	Calibration objective landscape	tables `calibration_iterations`
`calibration_objective_surface`	Calibration objective surface	tables `calibration_iterations`
`calibration_pairplot`	Calibration parameter pairs	tables `calibration_iterations`
`calibration_posterior`	Calibration parameter posteriors	tables `calibration_iterations`
`difference_map`	Difference map	(no fixed input)
`ensemble_band`	Ensemble envelope	tables `timeseries`
`hydrograph_sim_obs`	Discharge hydrograph (sim vs obs)	tables `timeseries`
`hydrographic_network_comparison`	Hydrographic network comparison	(no fixed input)
`hydrographic_network_generated`	Generated hydrographic network	(no fixed input)
`hydrographic_network_generated_extra_only`	Generated extra-only view	(no fixed input)
`hydrographic_network_reference`	BD Topage hydrographic network	(no fixed input)
`hydrographic_network_reference_missing_only`	Reference missing-only view	(no fixed input)
`piezo_timeseries_sim_obs`	Piezometric head (sim vs obs)	tables `timeseries`
`residuals`	Residuals (sim - obs)	tables `timeseries`
`scatter_one_to_one`	Sim vs obs scatter (1:1)	tables `timeseries`
`side_by_side`	Side-by-side map	(no fixed input)
`simulated_active_network_reference_overlay`	Simulated active network vs reference	fields `accumulation_flux`
`watershed_id_card`	Watershed identity card	(no fixed input)

Hydrochemistry diagrams#

Tabular hydrochemistry diagrams built from water-quality samples.

Figure name	Title	Required inputs
`piper_diagram`	Piper diagram	(no fixed input)
`schoeller_diagram`	Schoeller diagram	(no fixed input)
`stiff_diagram`	Stiff diagram	(no fixed input)

Choosing figures in TOML#

Simulation configurations can request report figures through the display section. Exact options depend on the current configuration schema:

[display]
figures = ["piezometric_map", "water_budget", "simulated_active_network"]

Use hmp viz gallery project.toml to rerender all figures after a run, hmp viz show <sim_id> <figure> to rerender one figure, and --no-display during hmp run when the workflow should persist results without rendering report figures.

Compatibility rule#

Figure names are stable entry points, but every figure still depends on data being present in the run store. If a figure cannot render, inspect the run first with:

hmp catalog show <sim_id> --detail
hmp catalog show <sim_id>

For low-level display objects, see API Reference.