Installation

Version stable

Due to the complexity of the install process of some dependencies, we strongly recommend installing xhydro in an Anaconda Python environment. To create a working environment and install xHydro, copy the environment-dev.yml file from the root of the repository and run the following commands:

conda env create -f environment-dev.yml
conda activate xhydro
python -m pip install xhydro --no-deps

C’est la méthode recommandée pour installer xHydro, car elle installera toujours la version stable la plus récente.

If for some reason you wish to install the PyPI version of xhydro into an existing Anaconda environment (not recommended if requirements are not met), only run the last command above.

Si vous n’avez pas installé pip, ce guide d’installation de Python peut vous guider à travers le processus.

À partir du code source

xHydro est toujours en développement actif et les dernières fonctionnalités peuvent ne pas être encore disponibles sur PyPI. Pour installer la dernière version de développement, vous pouvez installer xHydro directement depuis le dépôt Github.

Vous pouvez soit cloner le dépôt public :

git clone git@github.com:hydrologie/xhydro

Ou téléchargez le tarball :

curl -OJL https://github.com/hydrologie/xhydro/tarball/main

Une fois que vous avez une copie du code source, vous pouvez créer un environnement de travail et y installer xHydro :

conda env create -f environment.yml
conda activate xhydro
python -m pip install . --no-deps

Lorsque de nouveaux changements sont apportés au dépôt Github, vous pouvez mettre à jour votre copie locale en utilisant :

git pull origin main
conda env update -n xhydro -f environment.yml
conda activate xhydro
python -m pip install . --no-deps