HydroModPy v1.0.0
Year: 2026
Type: software
Abstract: HydroModPy (v1.0) : A Python toolbox for deploying catchment-scale shallow groundwater models. HydroModPy v1.0: the version cited in the paperThis v1.0 branch is the version described in the technical note submitted to Hydrology and Earth System Sciences (EGUsphere preprint, 2026). It is the reference cited by the paper and is kept up to date with fixes, so the paper link always points to a working v1.0. HydroModPy v2 is the actively developed version on the `main` branch, with new features and a redesigned interface. Presentation HydroModPy was initiated in 2018 to streamline the setup and deployment of hydrogeological models in catchments across the crystalline basement regions of Normandy and Brittany (France). The platform integrates multiple open-source libraries (e.g., FloPy, WhiteboxTools), providing a unified and reproducible framework that is easily accessible to the scientific community. The development of HydroModPy is driven by two main objectives: First, it automates the extraction and discretization of watersheds from Digital Elevation Models (DEMs) and enriches them with key hydrogeological datasets (e.g., piezometry, hydrography, geology) compiled from local, national, and global databases. This workflow ensures a standardized and reproducible approach for building and running simulation ensembles across multiple catchments using consistent input data. Second, it facilitates the visualization, analysis, and comparison of outputs from the different modelling components integrated within the platform. Beyond research applications, HydroModPy also serves as an educational tool, enabling students and researchers to explore hydrogeological modelling workflows in a practical and reproducible environment. Installation The recommended way to install HydroModPy is with `pip` from PyPI. A `conda`environment is also provided for the full scientific stack. Prerequisites - Python 3.11 to 3.13.- Important: your local path should not contain white spaces, to stay compatible with the MODFLOW-MODPATH suite. Install with pip (recommended) Install HydroModPy from PyPI: # without Spyder and JupyterLabpip install "hydromodpy==1.0.*" # latest 1.0.X, never 1.1 nor 2.0# including Spyder and JupyterLabpip install "hydromodpy[ide]==1.0.*" The ==1.0.* specifier always resolves to the latest 1.0.X patch and never crosses over to the v2 series. Use `==1.0.0` only to pin one exact release. MODFLOW, MODPATH and MT3DMS binaries ship with the package. The PyHELP binary downloads itself on the first call to the corresponding module. Install with conda Ready-to-use environment files live in the `install/` directory (clone the repository first, see "Get the source code" below): - env_hydromodpy.yml: full runtime stack, including Spyder.- env_hydromodpy_pkg.yml: same stack, then runs `pip install -e ..` to expose the cloned repository as an editable package.- env_hydromodpy_light.yml: minimal headless stack (no IDE, no 3D viewer).- requirements-docker-light.txt: pip requirements for a light Docker/server image. # from the repository rootconda env create -f install/env_hydromodpy.ymlconda activate hydromodpy Get the source code Needed for the conda environments above and for development (editable) installs. - Option 1: download the `.zip` archive directly from the GitHub project (https://github.com/HydroModPy/HydroModPy/tree/v1.0).- Option 2: clone the repository with a Git client such as GitHub Desktop (https://desktop.github.com/download/).- Option 3: use the command line: git clone https://github.com/HydroModPy/HydroModPy.gitcd HydroModPygit checkout v1.0 For development (editable) mode from the clone: pip install -e . Launch HydroModPy HydroModPy v1.0 was primarily developed for use with Spyder, so we recommend launching it from this IDE: 1. Activate the environment: conda activate hydromodpy 2. Open Spyder or Jupyter: spyder# orjupyter notebook 3. Import HydroModPy in Python: import hydromodpyfrom hydromodpy import Watershed # Check versionprint(hydromodpy.__version__) Examples Run the example scripts in `examples/` in this order: 00_quick_test_of_wide_hydromodpy_capabilities01_simplified_example_presented_in_the_paper02_basic_features_and_overview_of_possibilities03_hydrographic_network_in_steady_state04_streamflow_intermittence_in_transient05_piezometry_in_a_heterogeneous_coastal_aquifer06_particle_tracking_and_residence_times07_analytical_solution_for_streamflow_recession08_exponential_distribution_of_residence_times09_transport_model_for_an_agricultural_catchment10_coupling_with_land_surface_model_pyhelp11_run_from_scratch_without_plots The same examples are available as notebooks in the[documentation](https://docs.hydromodpy.fr/v1.0/). Documentation - v1.0 documentation: https://docs.hydromodpy.fr/v1.0/- v2 documentation (latest development): https://docs.hydromodpy.fr/main/ The v1.0 documentation is built and published automatically to`https://docs.hydromodpy.fr/v1.0/` on every update of the `v1.0` branch. Publications Papers published using HydroModPy: Bagagnan, R. S., Abhervé, R., Laverman, A. M., & Vautier, C. (2026). Groundwater controls on legacy antibiotics and pesticides in an intensive agricultural headwater catchment. Journal of Hydrology, 66. https://doi.org/10.1016/j.jhydrol.2026.135118 Abhervé, R., Roques, C., de Dreuzy, J.-R., Van Der Veen, T., Dumaine, L., Chatton, E., Brunner, P., Aquilina, L., & Servière, L. (2025). Projected climate change impacts on groundwater-surface water connectivity in a compartmentalized mountain headwater bedrock aquifer. Water Resources Research, 61(10). https://doi.org/10.1029/2025WR040083 Floriancic, M. G., Abhervé, R., Bouchez, C., Martinez, J. J., & Roques, C. (2024). Evidence of Groundwater Seepage and Mixing at the Vicinity of a Knickpoint in a Mountain Stream. Geophysical Research Letters, 51. https://doi.org/10.1029/2024GL111325 Le Mesnil, M., Gauvain, A., Gresselin, F., Aquilina, L., & de Dreuzy, J.-R. (2024). Characterizing coastal aquifer heterogeneity from a single piezometer head chronicle. Journal of Hydrology, 642. https://doi.org/10.1016/j.jhydrol.2024.131859 Abhervé, R., Roques, C., De Dreuzy, J.-R., Datry, T., Brunner, P., Longuevergne, L., & Aquilina, L. (2024). Improving calibration of groundwater flow models using headwater streamflow intermittence. Hydrological Processes, 38(6). https://doi.org/10.1002/hyp.15167 Abhervé, R., Roques, C., Gauvain, A., Longuevergne, L., Louaisil, S., Aquilina, L., & de Dreuzy, J.-R. (2023). Calibration of groundwater seepage against the spatial distribution of the stream network to assess catchment-scale hydraulic properties. Hydrology and Earth System Sciences, 27(17), 3221-3239. https://doi.org/10.5194/hess-27-3221-2023 How to cite If HydroModPy supports your work, please cite the technical note: Gauvain, A., Abhervé, R., Boivin, B., Coche, A., Le Mesnil, M., Babey, T., Maugan, E., Touzeau, T., Issolah, I., Roques, C., Bouchez, C., Marçais, J., Leray, S., Marti, E., Bresciani, E., Figueroa, R., Pélissier, M., Carlier, S., Guillaumot, L., Bagagnan, R. S., Vautier, C., Longuevergne, L., Sallou, J., Bourcier, J., Combemale, B., Brunner, P., Aquilina, L., and de Dreuzy, J.-R. (2026). Technical note: HydroModPy (V1.0.0) - a Python toolbox for deploying catchment-scale shallow groundwater models. EGUsphere [preprint]. https://doi.org/10.5194/egusphere-2026-868 Contact For any question regarding HydroModPy, please contact: [email protected]@[email protected]@univ-rennes.fr
Authors: Gauvain, Alexandre, Abhervé, Ronan, Boivin, Bastien, Coche, Alexandre, Le Mesnil, Martin, Babey, Tristan, Maugan, Enzo, Touzeau, Thea, Issolah, Imene, Roques, Clément, Bouchez, Camille, Marçais, Jean, Leray, Sarah, Marti, Etienne, Bresciani, Etienne, Figueroa, Ronny, Mathias Pélissier, Carlier, Simon, Guillaumot, Luca, Bagagnan, Rock S., Vautier, Camille, Longuevergne, Laurent, Sallou, June, Bourcier, Johan, Combemale, Benoit, Brunner, Philip, Aquilina, Luc, de Dreuzy, Jean-Raynald
Institutions: Centre National de la Recherche Scientifique, Sorbonne Université, Laboratoire de Météorologie Dynamique, Géosciences Rennes, Université de Rennes, Institut Agro Rennes-Angers, Institut National de Recherche pour l'Agriculture, l'Alimentation et l'Environnement, Sol Agro et hydrosystème Spatialisation, University of Neuchâtel, Institut national de recherche en sciences et technologies du numérique, Institut de Recherche en Informatique et Systèmes Aléatoires, Fonctionnement des hydrosystèmes, Pontificia Universidad Católica de Chile, University of O'Higgins, Bureau de Recherches Géologiques et Minières, Wageningen University & Research, Université de Pau et des Pays de l'Adour, Laboratoire Informatique de l'Université de Pau et des Pays de l'Adour
Language: English
Subfield: Environmental Engineering
Field: Environmental Science
Domain: Physical Sciences
Open Access status: green
OpenAlex ID: W7204563237