Regional Lab Transient Backend Comparison Recipe on Headwater 100 km2#

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 page narrows the committed regional_lab example to the transient_backend_compare recipe. It documents the same site population as the steady backend comparison, but with a transient comparison contract that depends on its own child config field and remains explicit about current coverage gaps.

See also

Read the Simulation walkthrough if you want the parameter mapping, a recommended reading order, and the first modifications to try.

Regional lab dry-plan synthesis for Regional Lab Transient Backend Comparison Recipe on Headwater 100 km2
Dry-plan synthesis for regional lab transient backend comparison recipe on headwater 100 km2: site or candidate coverage, recipe summary, and planning metrics.

Case Setup#

  • Base lab config: the selected headwater sites and cluster rules are unchanged so the page isolates the transient recipe, not the site population.

  • Overlay config: config_headwater_100km2_lab_transient_backend_compare.toml keeps only the transient_backend_compare recipe enabled.

  • Child-run contract: the recipe reads transient_backend_comparison_config from each site row and expands into the transient pulsed-recharge comparison suite.

What It Shows#

  • How two comparison recipes can coexist in one laboratory while pointing to different child configs and modelling questions.

  • How the transient backend-comparison recipe stays separate from the simpler backend-comparison recipe instead of overloading one flat page.

  • How recipe overlays can document a more specific transient workflow without cloning the site catalog or cluster rules.

Key Parameters#

  • id = ā€œtransient_backend_compareā€ keeps the transient question separate from the simpler backend-comparison recipe instead of collapsing both into one card.

  • required_fields = [ā€œtransient_backend_comparison_configā€] makes the missing transient child configs visible as coverage gaps rather than silent filtering.

  • launcher = ā€œcomparisonā€ plus the recipe-specific config path field is what lets one lab coordinate several comparison families in parallel.

  • The overlay config gives this page one exact reproduction command while preserving the shared base laboratory definition.

How To Read It#

  • Read the matrix first to see that the transient comparison recipe currently has the same one runnable outlet and two explicit gaps.

  • Use the coverage bar next to compare this transient slice with the simpler backend-comparison slice: same population, different child contract.

  • Use the planning summary last to keep the interpretation at the orchestration level before diving into the child comparison page itself.

Next Steps#

  • Switch execute = true in the focused overlay config when the dry plan looks correct and you want to launch the child workflow.

  • Use these orchestration pages as the planning complement to the individual simulation and comparison cases already exposed elsewhere in the gallery.

Reproduce#

Run the underlying example or validation case with:

python -m tools.doc_gallery

Refresh the committed gallery artifacts with:

python -m tools.doc_gallery

Source Pointers#

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_plan.json

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_report.json

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_summary.md

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_site_inventory.csv

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_recipe_summary.csv

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_cluster_summary.csv

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe_case_matrix.csv

  • hydromodpy/analysis/testbed/__init__.py

  • hydromodpy/analysis/testbed/regional_lab_config.py

  • hydromodpy/analysis/testbed/regional_lab.py

Artifacts#

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_transient_backend_compare_recipe.png

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