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, names
>>> "piezometric_map" in names()
True
>>> get("piezometric_map").spec.name
'piezometric_map'
>>> len(list_figures()) > 0
True

Rendering needs a Run backed by a simulation on disk:

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

Functions

get(name)	Return a fresh instance of the registered figure name.
list_figures()	Return the list of all registered figure specs, sorted by name.
names()	Iterate over the names of registered figures.
register(cls)	Class decorator.

Classes

BaseFigure()	ABC providing the universal plot() boilerplate.
Figure(*args, **kwargs)	The unique figure contract.
FigureSpec(name, title[, former_names, ...])	Static metadata describing one figure type.