Choose Your First Workflow#

Beginner5 min

Use this page when you know what you want to learn, but not which HydroModPy entry point to open first.

If you already know the CLI keyword you are looking for and want the full map of [workflow].mode = "..." families, use Workflow Reference.

Important

Default recommendation: start with Data Overview Walkthrough. It is the fastest way to understand basin setup, data loading, and case structure before any solver run.

Match your goal to a first page#

Inspect one basin before any solve

Start with Data Overview Walkthrough. Watershed extraction, domain setup, and data loading, without touching any solver.

hmp run examples/projects/04_data_overview/project.toml
Run one complete example end to end

Start with Simulation Walkthrough. See how geographic setup, meshing, and flow fit together in a single run.

hmp run examples/projects/06_vire_selune/run_vire_mf6_irregular.toml
Compare two numerical methods on the same support

Start with Simulation Comparison Workflow. A dedicated run workflow that generates child simulations, metrics, and difference figures.

hmp run examples/projects/09_comparison_workflow/compare_dupuit_mf6_bouss.toml
Check numerical credibility against a reference

Start with How To Read Gallery, Comparison, and Validation Pages. Validation pages explain analytical targets, solver coverage, and tolerance-based metrics.

python -m validation_cases.run_cases --solver modflow6 --regime both --no-show
Browse the full static inventory first

Start with Capability Gallery. A visual inventory: scan curated figures quickly before running anything locally.

python -m tools.doc_gallery

Default path for most users#

For most first-time contributors or users working from repository examples:

  1. Start with Data Overview Walkthrough.

  2. Continue with Simulation Walkthrough.

  3. Use How To Read Gallery, Comparison, and Validation Pages once you begin comparing methods or reading validation metrics.

Why not start with validation?#

Validation pages are useful, but they answer a different question. They tell you whether one numerical path reproduces an analytical or trusted reference. They do not teach the full user-facing workflow as directly as the data-overview and simulation examples.