BD Topage Hydrography Overlay#

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 case isolates one question: what HydroModPy actually displays when hydrography is loaded from BD Topage and only the hydrography panel is enabled. The figure is meant to document the loaded river network itself, without geology, stations, or time-series panels.

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, stopped after setup, domain assembly, data loading, and figure rendering.

  • Primary editable file: examples/projects/05_nancon_data_overview/config_hydrography_only.toml.

  • Only one output figure is enabled: [overview.panels] map_hydrography = true.

What It Shows#

  • How the data-overview launcher renders the clipped BD Topage network directly on top of the DEM.

  • Which files and panels matter for a hydrography-only audit before any solver or meshing stage.

  • How a TOML can be reduced to one single figure when the goal is to audit the river-network input.

How To Read It#

  • Open the figure first to check whether the displayed network visually matches the expected valley bottoms and basin extent.

  • Then inspect the minimal config and the versioned gallery source asset to separate loading intent from display styling.

  • If channels appear missing, compare this panel with the watershed boundary and review the BD Topage source options before changing downstream algorithms.

Next Steps#

  • Use the broader watershed overview case on the previous page when you want geology, stations, and observation windows documented together.

  • Reuse this minimal TOML as the shortest reproducible example for hydrography-display audits.

Reproduce#

Run the underlying example or validation case with:

python -m hydromodpy run examples/projects/05_nancon_data_overview/config_hydrography_only.toml

Refresh the committed gallery artifacts with:

python -m tools.doc_gallery

Case Parameters#

Selected Parameters#

Field

Meaning

Value

Source

[geographic.catchment] catch_def

Watershed extraction mode used to derive the basin from the outlet definition.

from_outlet_coord

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[geographic.catchment] x_outlet

Projected x coordinate of the outlet used by watershed extraction.

389286

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[geographic.catchment] y_outlet

Projected y coordinate of the outlet used by watershed extraction.

6.81652e+06

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[geographic.catchment] snap_dist

Maximum snapping distance used to align the requested outlet with the drainage network.

150 m

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[geographic.catchment] buff_area

Extra area kept around the watershed to preserve regional context in overview figures.

20%

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[data] types

Families of data loaded during the data-overview workflow.

hydrography

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

Loaded Data Families#

Field

Meaning

Value

Source

[data] types

Ordered list of data families requested by the overview case.

hydrography

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[data.hydrography.sources]

Configured providers used to load the hydrography family in this case.

bdtopage

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

Hydrography Source Options#

Field

Meaning

Value

Source

[[data.hydrography.sources]] source

Hydrography provider used for the displayed river network.

bdtopage

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[[data.hydrography.sources]] typename

Optional WFS typename used when the hydrography source is BD Topage.

sa:CoursEau_FXX_Topage2025

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[[data.hydrography.sources]] page_size

Pagination size requested from the remote hydrography API when relevant.

1000

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[[data.hydrography.sources]] rasterize_field

Attribute used when rasterizing the clipped vector network to the watershed grid.

FID

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

Overview Panels#

Field

Meaning

Value

Source

[overview] name

Title injected into the generated overview panels.

Nancon

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[overview.panels] enabled

Panel toggles enabled for this overview run.

map_hydrography

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[overview.panels] map_dem

Whether the map_dem panel is rendered for this overview case.

false

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[overview.panels] map_geology

Whether the map_geology panel is rendered for this overview case.

false

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[overview.panels] map_hydrography

Whether the map_hydrography panel is rendered for this overview case.

true

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

[overview.panels] stats_card

Whether the stats_card panel is rendered for this overview case.

false

examples/projects/05_nancon_data_overview/config_hydrography_only.toml

Source Pointers#

  • tools/doc_gallery/manifests/geographic_cases.json

  • examples/projects/05_nancon_data_overview/config_hydrography_only.toml

  • examples/projects/09_capability_gallery/geographic/README.md

  • examples/projects/09_capability_gallery/geographic/bdtopage_hydrography_overlay/geographic_bdtopage_hydrography_overlay.png

Artifacts#

  • docs/source/_static/capability_gallery/geographic/geographic_bdtopage_hydrography_overlay.png

  • docs/source/_static/capability_gallery/geographic/geographic_bdtopage_hydrography_overlay_summary.json stores the displayed metrics plus source hashes used by python -m tools.doc_gallery --check.