[display] DisplayConfig

TOML section: [display]

Pydantic model: DisplayConfig defined in hydromodpy.display.config.

Source on GitHub

Display behaviour resolved from the [display] TOML section.

Show fields: User User + Dev All

Fields

enabled

bool default = True user source

Master switch. When False, no figure is rendered or saved.

backend

Literal[‘agg’, ‘qt5agg’, ‘auto’] default = “auto” dev source

Matplotlib backend. ‘auto’ selects Agg in headless mode and a GUI backend when show is enabled.

preset

Literal[‘default’, ‘print’, ‘dark’] default = “default” user source

Named theme applied before rendering any figure.

show

bool default = False user source

Open an interactive window via matplotlib.pyplot.show.

save

bool default = True user source

Write rendered figures to disk under output_dir.

output_dir

Path default = “figures” user source

Directory (relative to project root) for saved figures.

dpi

int default = 150 dev source

DPI used when saving raster figures.

cmap

str default = “viridis” user source

Default sequential colormap for spatial figures.

figures

list[str] factory user source

Names of registered figures to auto-render at the end of hmp run (and consumed by hmp display). Empty list disables auto-rendering; figures can still be produced later with hmp display <toml>. Disable per-run via hmp run –no-display or for an entire Python Project via Project(…, no_display=True).

overrides in TOML: [display.overrides.<id>]

dict[str, dict] factory expert source

Per-figure keyword overrides, keyed by figure name (e.g. {'piezometric_map': {'cmap': 'cividis', 'vmin': 0}}).

flow in TOML: [display.flow]

DisplayFlowConfig factory user source

Flow figure switches.

Fields of DisplayFlowConfig

enabled

bool default = True user source

Master switch for flow figures.

cross_section

bool default = True user source

Render the flow cross-section plot.

streamflow

bool default = True user source

Render the streamflow comparison plot.

piezometry

bool default = True user source

Render the piezometry plot.

watertable_map

bool default = True user source

Render water-table maps.

dem_map

bool default = True user source

Render a DEM overview map.

budget

bool default = False user source

Render groundwater budget figures.

hydrography

bool default = True user source

Render hydrography maps.

boussinesq_state

bool default = True user source

Render the Boussinesq state figure.

boussinesq_diagnostics

bool default = True user source

Render Boussinesq diagnostics.

boussinesq_mass_balance

bool default = True user source

Render Boussinesq mass-balance diagnostics.

boussinesq_probes

bool default = True user source

Render Boussinesq probe time series.

boussinesq_edge_flux

bool default = True user source

Render final Boussinesq edge fluxes.

particles in TOML: [display.particles]

DisplayParticlesConfig factory user source

Particle figure switches.

Fields of DisplayParticlesConfig

enabled

bool default = True user source

Master switch for particle figures.

pathlines

bool default = False user source

Render particle pathlines.

transport in TOML: [display.transport]

DisplayTransportConfig factory user source

Transport figure switches.

Fields of DisplayTransportConfig

enabled

bool default = True user source

Master switch for transport figures.

concentration

bool default = False user source

Render concentration plots.

gif

bool default = False user source

Export concentration GIF animation.

web_animation

bool default = False user source

Export browser-friendly concentration animation.

Starter TOML snippet

Click to expand a copy-pasteable [display] 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.

[display]
# enabled = true
# preset = "default"
# show = false
# save = true
# output_dir = "figures"
# cmap = "viridis"
# figures = ...  # uses factory default

[display.flow]
# enabled = true
# cross_section = true
# streamflow = true
# piezometry = true
# watertable_map = true
# dem_map = true
# budget = false
# hydrography = true
# boussinesq_state = true
# boussinesq_diagnostics = true
# boussinesq_mass_balance = true
# boussinesq_probes = true
# boussinesq_edge_flux = true

[display.particles]
# enabled = true
# pathlines = false

[display.transport]
# enabled = true
# concentration = false
# gif = false
# web_animation = false

Entity-relationship diagram

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