Watershed Data Overview#
Note
This page and its static assets are auto-generated by python -m tools.doc_gallery. The Sphinx build only reads committed PNG and JSON artifacts.
This pair of figures documents the pre-solver side of HydroModPy. It shows how one watershed is contextualized before any flow run: local framing, DEM, and overlay-ready geographic inputs.
See also
Read the Data Overview walkthrough if you want the parameter mapping, a recommended reading order, and the first modifications to try.
Case Setup#
Launcher family: data-overview, so the workflow stops after setup, domain assembly, and data loading.
Primary editable file: examples/projects/04_data_overview/project.toml.
Committed figures are mirrored under examples/projects/09_capability_gallery/geographic/ so the doc build stays reproducible without a local results_stable checkout.
What It Shows#
How a watershed can be documented before any groundwater solve, using only setup and data loading.
How HydroModPy distinguishes a local watershed view from a broader DEM-oriented overview.
How versioned example outputs can feed static documentation without executing notebooks during the build.
How To Read It#
Read the DEM-oriented figure first to understand the broader terrain setting and outlet placement.
Read the local overview second to inspect which basin-scale overlays are available before any meshing or solving happens.
If the basin outline looks wrong, check outlet coordinates and snap distance before changing downstream modelling options.
Next Steps#
Continue with the data-overview walkthrough for a parameter-by-parameter reading strategy.
When the watershed framing looks correct, move to the simulation walkthrough to add meshing and solving.
Reproduce#
Run the underlying example or validation case with:
python -m hydromodpy run examples/projects/04_data_overview/project.toml
Refresh the committed gallery artifacts with:
python -m tools.doc_gallery
Case Parameters#
Selected Parameters#
Field |
Meaning |
Value |
Source |
|---|---|---|---|
|
Watershed extraction mode used to derive the basin from the outlet definition. |
from_outlet_coord |
|
|
Projected x coordinate of the outlet used by watershed extraction. |
127348 |
|
|
Projected y coordinate of the outlet used by watershed extraction. |
6.8358e+06 |
|
|
Maximum snapping distance used to align the requested outlet with the drainage network. |
150 m |
|
|
Extra area kept around the watershed to preserve regional context in overview figures. |
20% |
|
|
Domain layers kept on the spatial support before any meshing or solving stage. |
geology |
|
|
Constant basin thickness assigned by the depth model when that mode is selected. |
50.0 m |
|
|
Families of data loaded during the data-overview workflow. |
geology, hydrography, hydrometry, intermittency, oceanic |
|
|
Policy controlling how strictly the data-loading stage resolves requested layers. |
strict |
|
Loaded Data Families#
Field |
Meaning |
Value |
Source |
|---|---|---|---|
|
Ordered list of data families requested by the overview case. |
geology, hydrography, hydrometry, intermittency, oceanic |
|
|
Configured providers used to load the geology family in this case. |
brgm_1m |
|
|
Configured providers used to load the hydrography family in this case. |
custom |
|
|
Configured providers used to load the hydrometry family in this case. |
hubeau |
|
|
Configured providers used to load the intermittency family in this case. |
hubeau |
|
|
Configured providers used to load the oceanic family in this case. |
shom |
|
Hydrography Source Options#
Field |
Meaning |
Value |
Source |
|---|---|---|---|
|
Hydrography provider used for the displayed river network. |
custom |
|
|
Attribute used when rasterizing the clipped vector network to the watershed grid. |
FID |
|
Overview Panels#
Field |
Meaning |
Value |
Source |
|---|---|---|---|
|
Title injected into the generated overview panels. |
Watershed Data Overview |
|
|
Panel toggles enabled for this overview run. |
map_dem, map_geology, map_hydrography, stats_card, timeseries_discharge, timeseries_intermittency, station_inventory |
|
|
Whether the map_dem panel is rendered for this overview case. |
true |
|
|
Whether the map_geology panel is rendered for this overview case. |
true |
|
|
Whether the map_hydrography panel is rendered for this overview case. |
true |
|
|
Whether the stats_card panel is rendered for this overview case. |
true |
|
Observation Windows#
Field |
Meaning |
Value |
Source |
|---|---|---|---|
|
Start date used when querying hydrometry observations for this case. |
2019-01-01 |
|
|
End date used when querying hydrometry observations for this case. |
2025-12-31 |
|
|
Start date used when querying intermittency observations for this case. |
2019-01-01 |
|
|
End date used when querying intermittency observations for this case. |
2025-12-31 |
|
|
Start date used when querying oceanic observations for this case. |
2003-01-01 |
|
|
End date used when querying oceanic observations for this case. |
2003-01-30 |
|
Source Pointers#
tools/doc_gallery/manifests/geographic_cases.jsonexamples/projects/04_data_overview/project.tomlexamples/projects/09_capability_gallery/geographic/README.mdexamples/projects/09_capability_gallery/geographic/watershed_overview/geographic_watershed_dem.pngexamples/projects/09_capability_gallery/geographic/watershed_overview/geographic_watershed_local.png
Artifacts#
docs/source/_static/capability_gallery/geographic/geographic_watershed_dem.pngdocs/source/_static/capability_gallery/geographic/geographic_watershed_local.pngdocs/source/_static/capability_gallery/geographic/geographic_watershed_overview_summary.jsonstores the displayed metrics plus source hashes used bypython -m tools.doc_gallery --check.