Regional Lab 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 backend_compare recipe. It shows how one comparison workflow is carried as a reusable recipe, planned only where the catalog exposes one backend-comparison config, and reported with explicit gaps on the remaining headwater sites.

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 Backend Comparison Recipe on Headwater 100 km2
Dry-plan synthesis for regional lab backend comparison recipe on headwater 100 km2: site or candidate coverage, recipe summary, and planning metrics.

Case Setup#

  • Base lab config: the same selected headwater population is reused, so the page isolates recipe logic rather than changing the site inventory.

  • Overlay config: config_headwater_100km2_lab_backend_compare.toml keeps only the backend_compare recipe enabled and writes to its own output root.

  • Child-run contract: the recipe reads backend_comparison_config from each site row and expands into comparison child runs.

What It Shows#

  • How regional_lab can orchestrate comparison launchers, not only single-run simulations.

  • How one comparison recipe reuses the same headwater site selection while depending on a different catalog field than the MF6 replay recipe.

  • How the dry plan remains useful even when only one site is currently comparison-ready.

Key Parameters#

  • launcher = “comparison” shows that regional_lab can plan solver-comparison suites as first-class child workflows.

  • required_fields = [“backend_comparison_config”] is what turns the two inventory-only headwater sites into visible comparison gaps.

  • config_path_template = “{backend_comparison_config}” keeps the recipe generic while the site catalog remains the source of truth for child inputs.

  • The overlay keeps the other recipes disabled so the page documents one comparison workflow rather than the full laboratory at once.

How To Read It#

  • Start with the matrix to confirm that the backend-comparison recipe currently lands on one validated outlet only.

  • Use the coverage summary to separate recipe reach from recipe quality: one planned case can still be valuable if the gaps stay explicit.

  • Read the text panel last to connect those gaps to catalog maturity rather than to launcher failure.

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_backend_compare_recipe_plan.json

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

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

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

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

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

  • docs/source/_static/capability_gallery/simulation/regional_lab_headwater_100km2_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_backend_compare_recipe.png

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