[overview] OverviewConfig

TOML section: [overview]

Pydantic model: OverviewConfig defined in hydromodpy.display.overview.config.

Source on GitHub

Overview report settings (watershed identity card).

Show fields: User User + Dev All

Fields

name

str default = “” user source

Watershed name.

date_start

str | None default = None user source

Start of the overview window (ISO date, e.g. ‘2019-01-01’). Overview mode has no [simulation.time], so this is the date declaration every [data.<type>] section without a window of its own inherits. Must be declared together with date_end.

Example: "2019-01-01"

date_end

str | None default = None user source

End of the overview window (ISO date, e.g. ‘2025-12-31’). Overview mode has no [simulation.time], so this is the date declaration every [data.<type>] section without a window of its own inherits. Must be declared together with date_start.

Example: "2025-12-31"

regional_context_label

str | None default = None user source

Label used for the regional location figure.

panels in TOML: [overview.panels]

OverviewPanelsConfig factory user source

Panel toggles.

Fields of OverviewPanelsConfig

map_dem

bool default = True user source

DEM elevation map.

map_geology

bool default = True user source

Geology lithology map.

map_hydrography

bool default = True user source

River network map.

stats_card

bool default = True user source

Watershed metrics card.

timeseries_discharge

bool default = True user source

Observed discharge.

timeseries_piezometry

bool default = True user source

Observed piezometry.

climatic_summary

bool default = True user source

P/ETP monthly bars.

timeseries_intermittency

bool default = True user source

ONDE intermittency.

timeseries_water_quality

bool default = True user source

Water-quality series.

station_inventory

bool default = True user source

Station inventory table.

Starter TOML snippet

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

[overview]
# name = ""
# date_start = ...  # default = None
# date_end = ...  # default = None
# regional_context_label = ...  # default = None

[overview.panels]
# map_dem = true
# map_geology = true
# map_hydrography = true
# stats_card = true
# timeseries_discharge = true
# timeseries_piezometry = true
# climatic_summary = true
# timeseries_intermittency = true
# timeseries_water_quality = true
# station_inventory = true

Entity-relationship diagram

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