Getting Started#
This section is the shortest guided entry point for HydroModPy. Use it when you want to install the package, choose a first workflow, and run one meaningful case without scanning the full documentation tree.
For most users, the default path is simple: choose the right first workflow, run the data-overview case, then move to the end-to-end simulation case.
Note
If you installed HydroModPy from PyPI, the package does not ship the
repository examples/ directory. Follow Install first, then use
the guides below with a cloned repository or the downloaded source archive.
Important
If you are unsure where to start, read Concepts in 5 minutes first, then Choose Your First Workflow, run CLI quickstart, and continue with Data Overview Walkthrough.
Recommended entry points#
Concepts in 5 minutes
The five core concepts (Project, Run, Workflow, Catchment, Solver) the rest of the documentation assumes you have already met.
Start here
Match your goal to the right first example: data-only setup, full simulation, comparison, or validation.
CLI quickstart
Scaffold a workspace, create a project, generate a config template, and run a simulation from the command line in five steps.
Data overview walkthrough
Start with a no-solver workflow that extracts one basin and loads the main geographic data layers.
Simulation walkthrough
Follow one end-to-end MODFLOW 6 plus Gmsh case and map the main config sections to the displayed outputs.
Default path#
Follow CLI quickstart to scaffold a workspace, create a project, and run a first simulation from the command line.
Run Data Overview Walkthrough if you want to understand basin setup before touching any solver.
Continue with Simulation Walkthrough for a complete end-to-end case.