Install#

Requirements#

Python 3.11 or newer (HydroModPy v0.3.0 dropped support for older versions; see v0.3.0 (November 2025)).
Git (only needed if you install from the repository).
MODFLOW, MODPATH and MT3DMS binaries are included with every installation (PyPI and repository installs).
The PyHELP binary downloads itself on the first call to the helper module.

Install with pip#

PyPI (latest master)

python -m pip install --upgrade pip
pip install hydromodpy

This installs the published release from PyPI and exposes the package as hydromodpy in any environment. Need an IDE bundle (Spyder + JupyterLab)? install hydromodpy[ide] instead.

Editable clone

git clone https://gitlab.com/Alex-Gauvain/HydroModPy.git
cd HydroModPy
python -m pip install --upgrade pip
pip install -e .

Editable mode installs the package from the local repository while keeping the source tree editable. Ideal for contributions or quick fixes. Install the [docs] extras later only if you work on the documentation.

Full pip packaging is available from v0.3.0 onward. Users pinned to older releases should rely on the conda environment and the v0.2.0 tag.

Install with conda#

Two ready-to-use environment files live in install/. Pick the tabbed recipe that matches your workflow.

Conda (Runtime stack)

Installs the runtime stack (Spyder included) for executing scripts and notebooks without touching the local source tree.

conda env create -n <env> -f install/env_hydromodpy.yml
conda activate <env>

When running scripts or notebooks inside this repository, append the project root to sys.path so the runtime-only environment sees the package:

# ROOT DIRECTORY
import sys
sys.path.append(r"/absolute/path/to/your/HydroModPy")

Pip-based installs expose hydromodpy globally, so the snippet is not required outside this workflow.

Conda (Editable stack)

Sets up the same environment but finishes with pip install -e .. so the cloned repository stays importable everywhere.

conda env create -n <env>-pkg -f install/env_hydromodpy_pkg.yml
conda activate <env>-pkg

Run the commands from the repository root (install/ sits at the top level) so the relative pip install -e .. executed by the YAML file can reach the project.

Command recipes#

Pick the setup that matches your workflow. Replace <env> with your environment name, set <py> to the desired Python version (3.11–3.13), and switch hydromodpy to "hydromodpy[docs]" if you need the documentation extras.

Upgrade#

pip install --upgrade hydromodpy

Editable installs can be updated with git pull followed by the same command.

Check the installation#

import hydromodpy
from hydromodpy import watershed_root
# Examples of submodule imports
from hydromodpy.display import visualization_watershed, visualization_results
from hydromodpy.tools import toolbox

font_sizes = toolbox.plot_params(8, 15, 18, 20)  # small, medium, intermediate, large
print(hydromodpy.__version__)

Refer to Examples for complete notebooks and scripts once the import works.

Spyder note#

spyder-kernels ships with HydroModPy so Spyder can attach to any prepared environment. Install the IDE itself via the Conda YAML files (Spyder is already included) or by adding the ide extra

pip install "hydromodpy[ide]"

Manual install remains possible with conda install spyder.

Python 3.8 users#

If you must stay on Python 3.8.10, stick to release v0.2.0 by cloning Alex-Gauvain/HydroModPy/-/releases/v0.2.0 and following the conda recipe above. Later versions require Python 3.11+ and will not install on older interpreters.