hydromodpy.display#

Solver-agnostic figure rendering for HydroModPy simulations.

Figures consume the Run catalog interface; they never touch a solver, a project state or raw output files. The same figure code therefore renders MODFLOW-NWT, MODFLOW 6 and Boussinesq results identically.

Public API:

>>> from hydromodpy.display import get, list_figures
>>> get("piezometric_map").plot(sim, save_path="head.png")

Modules

animation

Animation builders that stitch pre-rendered PNG frames together.

banner

HydroModPy ASCII banner.

catalog

Registry of named figures.

catchment_report

Catchment-scale report assembly helpers.

colormaps

Colormap policy.

config

Pydantic schema for the [display] TOML section.

figure

Figure protocol and base class shared by every HydroModPy figure.

figures

Figure implementations.

geo

Geographic figure helpers.

map_axes

Shared helpers for HydroModPy spatial figures.

overview

Overview report - watershed identity-card panel rendering.

png_metadata

PNG metadata helpers (tEXt chunks via Pillow).

renderer

Matplotlib backend lifecycle and figure saving.

report_blocks

Reusable static report block primitives.

runs

Per-run figure rendering helpers.

scalable

Scalable rasterization helpers for dense meshes and large 2D fields.

theme

Display theme presets.

ugrid

UGRID mesh rendering helper shared by spatial figures.

viz

Public hmp.viz dispatcher exposed at the top level.