Installation

Nous vous recommandons fortement d’installer xhydro dans un environnement Anaconda Python. De plus, en raison de la complexité de certains paquets, le solveur de dépendances par défaut peut prendre beaucoup de temps pour résoudre l’environnement. Si mamba n’est pas déjà votre solveur par défaut, envisagez d’exécuter les commandes suivantes afin d’accélérer le processus :

conda install -n base conda-libmamba-solver
conda config --set solver libmamba

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

Version stable

En raison de la complexité du processus d’installation de certaines dépendances, xhydro ne doit pas être installé directement à partir de PyPI, sauf si vous êtes sûr que toutes les dépendances sont remplies.

Jusqu’à ce que la librairie soit disponible sur Conda-Forge pour une installation plus simplifiée, nous vous recommandons de suivre les instructions ci-dessous, mais en remplaçant la première étape par les fichiers de la dernière version sur PyPI.

Pour créer un environnement de travail et installer xHydro, copiez le fichier environment-dev.yml depuis le root du dépôt et exécutez les commandes suivantes :

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

This is the preferred method to install xHydro, as it will always install the most recent stable release.

Si pour une raison quelconque vous souhaitez installer la version PyPI de xHydro dans un environnement Anaconda existant (non recommandé si les dépendances ne sont pas remplies), exécutez seulement la dernière commande ci-dessus.

À partir du code source

xHydro is still under active development and the latest features might not yet be available on PyPI.

The sources for xHydro can be downloaded from the Github repo.

1. Download the source code from the Github repo using one of the following methods:

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

     git clone git@github.com:hydrologie/xhydro
     

   • Download the tarball:

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

2. Once you have a copy of the source, you can install it with:

   conda env create -f environment-dev.yml
   conda activate xhydro-dev
   make dev
   

   If you are on Windows, replace the make dev command with the following:

   python -m pip install -e .[dev]
   
   Even if you do not intend to contribute to `xHydro`, we favor using `environment-dev.yml` over `environment.yml` because it includes additional packages that are used to run all the examples provided in the documentation.
   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.
   

3. Lorsque de nouvelles modifications sont apportées au dépôt Github, vous pouvez mettre à jour votre copie locale à l’aide des commandes suivantes depuis la racine du dépôt :

   git fetch
   git checkout main
   git pull origin main
   conda env update -n xhydro-dev -f environment-dev.yml
   conda activate xhydro-dev
   make dev
   

   Ces commandes devraient fonctionner la plupart du temps, mais si des modifications importantes sont apportées au dépôt, vous devrez peut-être supprimer l’environnement et le recréer.