Mesh Sample Bundle#

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 sample bundle is a versioned catchment mesh illustration shipped with the repository. It is stable enough for documentation and exposes the main viewer concepts: cells, edges, rivers, geology interfaces, and topography rendering.

Mesh sample bundle overview with geology and topography panels
Standalone mesh overview generated from the shipped sample bundle and viewer TOML.

What It Shows#

  • How the standalone bundle viewer turns one versioned mesh export into a didactic figure.

  • How geology keys, river edges, and topographic information are surfaced in one compact layout.

  • What one real exported bundle looks like when used as a reproducible documentation artifact.

Key Metrics#

  • Nodes: 4

  • Cells: 2

  • River edges: 1

  • Geology interfaces: 1

Reproduce#

Run the underlying example or validation case with:

python -m tools.mesh_bundle_viewer --config examples/projects/08_mesh_viewer/config_example.toml

Refresh the committed gallery artifacts with:

python -m tools.doc_gallery

Case Parameters#

Selected Parameters#

Field

Meaning

Value

Source

[mesh_distribution.plot] color_field

Cell attribute used to color the mesh in the overview figure.

geology_key

examples/projects/08_mesh_viewer/config_example.toml

[mesh_distribution.plot] show_topography_panel

Whether a dedicated topography panel is shown alongside the mesh map.

true

examples/projects/08_mesh_viewer/config_example.toml

[mesh_distribution.plot] topography_field

Node or cell field used to render the topography panel when it is enabled.

z_top_mean

examples/projects/08_mesh_viewer/config_example.toml

[mesh_distribution.plot] show_geology_interfaces

Whether geology interfaces are explicitly highlighted in the viewer output.

true

examples/projects/08_mesh_viewer/config_example.toml

[mesh_distribution.plot] show_river_edges

Whether river-constrained edges are highlighted in the viewer output.

true

examples/projects/08_mesh_viewer/config_example.toml

Mesh Summary#

Field

Meaning

Value

Source

crs

Coordinate reference system declared by the imported mesh bundle.

EPSG:2154

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

node_count

Number of nodes available in the displayed mesh bundle.

4

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

cell_count

Number of cells available in the displayed mesh bundle.

2

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

edge_count

Number of edges available in the displayed mesh bundle.

5

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

river_edge_count

Count of edges tagged as river constraints in the bundle.

1

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

boundary_edge_count

Count of watershed-boundary edges in the bundle.

4

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

geology_interface_edge_count

Count of geology-interface edges present in the bundle.

1

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

geology_keys

Distinct geology codes present in the imported bundle.

granite, schist

docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_summary.json

Source Pointers#

  • examples/projects/08_mesh_viewer/config_example.toml

  • examples/projects/08_mesh_viewer/default_bundle/README.md

  • tools/mesh_bundle_viewer/README.md

  • tools/mesh_bundle_viewer/runner/visualization_runner.py

  • tools/mesh_bundle_viewer/display/figure.py

  • tools/mesh_bundle_viewer/display/summary.py

Artifacts#

  • docs/source/_static/capability_gallery/mesh/mesh_sample_bundle_overview.png

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