Regional Lab MF6 Reference 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 mf6_reference recipe. It shows how one simulation recipe consumes one catalog field, expands only across the compatible headwater sites, and keeps missing child configs visible as explicit 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 MF6 Reference Recipe on Headwater 100 km2
Dry-plan synthesis for regional lab mf6 reference recipe on headwater 100 km2: site or candidate coverage, recipe summary, and planning metrics.

Case Setup#

  • Base lab config: config_headwater_100km2_lab.toml selects mesh_ready sites, enriches the headwater cluster through rules, and defines three reusable recipes.

  • Overlay config: config_headwater_100km2_lab_mf6_reference.toml keeps only the mf6_reference recipe enabled and writes to a dedicated output directory.

  • Child-run contract: the recipe reads simulation_reference_config from each candidate site row rather than deriving one path from naming conventions alone.

What It Shows#

  • How one reusable simulation recipe is expanded from the regional site catalog instead of hard-coding one child config path per case page.

  • How required_fields = [“simulation_reference_config”] turns missing references into explicit recipe-level gaps.

  • How recipe-specific overlay configs keep the reproduction command precise without duplicating the whole laboratory definition.

Key Parameters#

  • [[regional_lab.recipe]] id = “mf6_reference” plus the overlay enabled flags define the focused orchestration slice documented by this page.

  • families = [“headwater”] and scales = [“100km2”] scope the recipe before any child config path is resolved.

  • required_fields = [“simulation_reference_config”] is the gate that separates the one runnable outlet from the two inventory-only headwater sites.

  • config_path_template = “{simulation_reference_config}” delegates the concrete simulation config choice to the catalog row.

How To Read It#

  • Read the matrix first: it shows one runnable headwater outlet and two recipe-level gaps on the same selected population.

  • Use the coverage bar next to judge how far the committed catalog already goes for this replay workflow before adding more child configs.

  • Finish with the planning summary to connect the remaining gaps to site maturity and cluster scope.

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

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

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

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

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

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

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

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