Guide de l'utilisateur
Installation
HABBY avec un exécutable
Windows
- Téléchargez le fichier 'HABBY-setup-64.zip'
- Lancer le fichier d’installation 'HABBY-setup-64.exe' préalablement dézippé.
Linux
- Téléchargez le fichier “habby.zip”
- Décompressez le fichier “habby.zip”
- Lancez l’exécutable “habby” dans le répertoire “habby”
Mac
HABBY avec Python
Dépendances
Le projet Python HABBY est hébergé sur Github accessible au lien suivant : https://github.com/YannIrstea/habby.
- Python >= 3
- Git
Aide à la création de l'environnement Python pour Windows
- Installer les dépendances.
- Télécharger la wheele GDAL : https://github.com/cgohlke/geospatial-wheels
- Installer Microsoft Visual C++ 14.0 : https://visualstudio.microsoft.com/fr/visual-cpp-build-tools/ si besoin
- Ouvrez le fichier 'creation_env_habby.bat' et spécifiez :
- le chemin d'accès à votre Python système en remplaçant le chemin de la variable : 'python_source_path=' ;
- le chemin d'accès à votre la wheel GDAL que vous avez préalablement téléchargée en remplaçant le chemin de la variable : 'gdal_wheel_path=' ;
- sauvegardez le fichier.
- Lancer le fichier 'creation_env_habby.bat'.
- Si toutes les étapes se sont bien déroulées, vous devriez voir apparaitre la fenêtre principale d'HABBY.
- Votre environnement virtuel Python pour HABBY est prêt.
Aide à la création de l'environnement Python pour Linux
- installation de GDAL for Linux and GDAL for Python (https://mothergeo-py.readthedocs.io/en/latest/development/how-to/gdal-ubuntu-pkg.html)
sudo apt-get install python3.6-dev sudo add-apt-repository ppa:ubuntugis/ppa sudo apt-get update sudo apt-get install gdal-bin ogrinfo --version sudo apt-get install libgdal-dev
- Lancer le fichier 'tips\virtual_envs\creation_env_habby_pip.sh'.
pip3 install pip --upgrade pip3 install virtualenv cd ../habby_dev virtualenv --python /usr/bin/python3.6 env_virtuels/env_habby_dev_pip source env_virtuels/env_habby_dev_pip/bin/activate pip3 install gdal==X.X.X --global-option=build_ext --global-option="-I/usr/include/gdal/" pip3 install -r habby/requirements.txt python habby/habby.py
Autres logiciels
Pour visualiser les exports d'HABBY, il est souhaitable de disposer de :
- d'un SIG (QGIS, ArcGIS, ..)
- ainsi que de Paraview (https://www.paraview.org/)
- ainsi qu'un tableur, comme LibreOffice Calc ou Excel
Création de projet
Une fois le logiciel lancé, vous pouvez créer un projet HABBY de type :
- physique : permet des calculs d'habitat à partir de modèle physiques (Telemac, HEC-RAS, ..)
- ouverture des onglets physiques.
- statistique : permet des calcul d'habitat à partir de modèles statistiques (Estimhab, Stathat et FStress)
- ouverture des onglets statistiques.
- les deux : permet des calcul d'habitat à partir de modèles physiques et statistiques.
- ouverture des onglets physiques et statistiques.
Pour cela cliquez sur le menu Projet - Nouveau.
Dans la nouvelle fenêtre HABBY Nouveau Projet :
- Si nécessaire, changez le Répertoire de projet: en cliquant sur
.- Par défaut, les projets HABBY sont stockés dans le répertoire 'HABBY_projects', par exemple pour Windows : 'C:\Users\UserName\Documents\HABBY_projects'
- Si nécessaire, ajustez le Nom de projet: par défaut “DefaultProj”.
- Choisissez le Type de projet: HABBY que vous souhaitez puis cliquez sur [Créer un projet].
NB: A tout moment, il est possible de changer de type de projet avec le menu Projet - Onglets - Onglet physique ou statistique.
L'explorateur de modèles biologiques
Dans ce premier onglet Filtre de modèle de la fenêtre Explorateur de modèle biologique, utilisez les différents Filtres pour affiner votre recherche au niveau des Filtres code Onema, puis passez à l'onglet suivant Choix du modèle.
Dans ce deuxième onglet Choix du modèle de la fenêtre Explorateur de modèle biologique, il est possible de visualiser les modèles biologiques en graphique ainsi que leur hydrosignature quand cette dernière est disponible.
Glissez-déposez le(s) modèle(s) dans la liste de droite puis valider avec le bouton Valider les modèles sélectionnés pour le(s) ajouter à l'onglet Calc. hab de la fenêtre principale.
NB : Pour ajouter des modèles biologiques externes au logiciel, se référer à Manuel de référence - Les modèles biologiques
Calcul d'habitat à partir de modèles 2D
Création d'un fichier hydraulique .hyd
Données acceptées
Introduction
Type de données hydraulique acceptées
1D- 2D
- Écoulement permanent
- Écoulement transitoire
Les objectifs
- Permanent : étude de l’habitat aquatique pour un ou plusieurs débits donnés
- Transitoire : étude de l’habitat aquatique selon le temps
Contrôles
- Pas de contrôle de vraisemblance hydraulique (contre-pente, valeur de variable absurdes,
- Pas de contrôle de vraisemblance topologique
- Hauteur d’eau < 0 supprimées
- Découpage mailles semi-mouillée en option
Écoulement permanent
Pour générer un écoulement permanent dans un tronçon de rivière, les logiciels de modélisation nécessitent plusieurs pas de temps de calcul avant de converger vers un écoulement stable (hauteurs et vitesses). Généralement, l’écoulement est réputé permanent au dernier pas de temps de calcul. Le modélisateur peut exporter les résultats de simulation dans un fichier de résultat comprenant :
- Soit la totalité des pas de temps de calcul (permettant d’atteindre l’écoulement permanent) ;
- Soit un seul pas de temps où l’écoulement est dit permanent.
Un fichier de résultat hydraulique de type écoulement permanent peut contenir un ou plusieurs pas de temps.
Écoulement transitoire
Pour générer un écoulement transitoire dans un tronçon de rivière, les logiciels de modélisation calculent sur plusieurs pas de temps l’évolution de l’onde hydraulique au cours du temps. Le modélisateur peut exporter les résultats de simulation dans un fichier de résultat comprenant :
- Soit la totalité des pas de temps de calcul ;
- Soit une partie des pas de temps de calcul pour extraire une chronique spécifique.
Un fichier de résultat hydraulique de type écoulement transitoire contient plusieurs pas de temps.
Pour connaître la description des fichiers acceptés, se référer à Manuel de référence - Logiciels de modélisation hydraulique
Le fichier 'indexHYDRAU.txt' est utile pour une utilisation avancée du logiciel. Ce dernier permet par exemple d'assigner des valeurs de débit à plusieurs fichiers d'entrée pour assembler ces derniers en un seul fichier .hyd.
Utilisation de l'onglet Hydraulique
A partir de l'onglet Hydraulique :
- Choisissez un modèle hydraulique
- Utilisez le bouton pour sélectionner un fichier hydraulique d'entrée adapté au modèle hydraulique préalablement sélectionné.
- Une fois le fichier sélectionné, les caractéristiques affichées dans l'interface :
- Fichier de résultat : nom de fichier sélectionnés.
- Nom de tronçon : nom de tronçon (ajustable si plusieurs tronçons disponibles).
- Nom d'unité : nom d'unité (ajustable si plusieurs unités disponibles).
- Type : type d'unité (débit ou temps).
- Nombre : nombre d'unité sélectionné / nombre total disponible.
- Données aux mailles : données hydrauliques aux mailles détectées par HABBY comme exploitable.
- Données aux nœuds : données hydrauliques aux nœuds détectées par HABBY comme exploitable.
- Code EPSG : système de coordonnées géographiques détecté par HABBY : https://fr.wikipedia.org/wiki/Syst%C3%A8me_de_coordonn%C3%A9es
- Nom de fichier .hyd : nom du fichier .hyd.
- Si nécessaire, ajustez certaines caractéristiques.
- Lancez la création du fichier en cliquant sur Créer un fichier .hyd.
Création de fichier substrat .sub
Données acceptées
Selon la méthode d’acquisition, le substrat du cours d’eau peut être décrit par différentes méthodes et différents types d’entrées pour HABBY.
| Méthode de cartographie du substrat | Représentation en plan | Entrée associée |
|---|---|---|
| Polygone : polygones contenants une entité de substrat homogène |  | SIG (.shp, .gpkg) |
| Point : mesures ponctuelles discrétisant le substrat en petites entités homogènes pour lesquelles HABBY construira des polygones de Voronoï |  | SIG (.shp, .gpkg) et texte (.txt) |
| Constante: substrat considéré homogène sur la totalité du site étudié |  | Texte (.txt) |
Pour connaître en détail le contenu des fichiers acceptés, se référer à Manuel de référence - Description détaillée des fichiers substrat
Utilisation de l'onglet Substrat
A partir de l'onglet Substrat :
- Choisissez une méthode de cartographie du substrat.
- Utilisez le bouton pour sélectionner un fichier substrat d'entrée adapté au type de représentation préalablement sélectionné.
- Une fois le fichier sélectionné, les caractéristiques affichées dans l'interface :
- Fichier : Nom de fichier sélectionnés.
- Code de classification : Code de classification du substrat détecté.
- Méthode de classification : Méthode de classification du substrat détecté.
- Valeurs par défaut : Valeur de substrat par défaut détecté (en cas de non-superposition de l'hydraulique et du substrat).
- Code EPSG : Système de coordonnées géographiques du substrat non constant, détecté par HABBY : https://fr.wikipedia.org/wiki/Syst%C3%A8me_de_coordonn%C3%A9es
- Nom de fichier .sub : Nom du fichier .sub à céer.
- Si nécessaire, ajustez certaines caractéristiques.
- Lancez la création du fichier en cliquant sur Créer un fichier .sub.
Création de fichier habitat .hab
A partir de l'onglet 'Substrat', lancement de la fusion :
Calcul d'habitat à partir d'un fichier habitat .hab
Choix du fichier habitat .hab
Dans l'onglet 'Calc. hab' de la fenêtre principale, sélectionnez un fichier habitat .hab dans la liste.
Ajoutez des modèles biologiques en ouvrant l'explorateur de modèle biologique.
Choix des options de calcul
Ces options de calcul sont disponibles pour chaque modèles sélectionnés et permettent de tester l'influence de chaque variables d'hydraulique et de substrat.
Options hydraulique :
- HV : Hauteur et Vitesse
- H : Hauteur
- V : Vitesse
- Neglect : Négliger les variables d'hydrauliques
Options substrat :
- Coarser-Dominant : substrat plus-gros/dominant
- Coarser : substrat plus-gros
- Dominant : substrat dominant
- Percentage : substrat en pourcentage
- Neglect : Négliger les variables de substrat
Afin d'améliorer le calcul d'habitat, il est conseillé de laisser les valeurs par défauts (en vert).
Calcul
Vous pouvez lancer le calcul. Un fois ce dernier terminé, vous pouvez visualiser ou exporter les résultats à partir de l'onglet 'Explorateur de données'.
Explorateur de données
Préambule
Dans l'onglet 'Explorateur de données', sélectionnez un type de fichier (hydraulique, substrat ou habitat) puis sélectionnez un fichier dont vous souhaitez visualiser ou exporter les résultats.
Figures
Dans le groupe 'Visualisateur/exporteur de figure' vous pouvez visualiser une cartographie, en choisissant :
- le nom de tronçon
- le(s) unité(s), qui peuvent être de type débit ou du temps selon les fichier hydrauliques d'entrées
- le(s) nom(s) de variable dans la colonne 'variables aux nœuds'
- le(s) nom(s) de variable dans la colonne 'variables aux mailles'
Pour visualiser les variables de résultat de calcul d'habitat en histogramme ou courbe en fonction des unités choisis, vous pouvez cocher l'option 'Valeur globale d'habitat' et/ou décocher la l'option 'carte'.
Exports
Ce groupe permet d'exporter manuellement les fichiers de sortie. Cocher les fichiers souhaités puis lancer le processus.
Astuce : Il est possible d'activer/désactiver tous les exports en double-cliquant dans le groupe.
Information de fichier
Ce groupe permet d'afficher les métadonnées du fichier sélectionné.
Suppression de valeur d'habitat
Ce groupe, accessible seulement avec les fichiers .hab, permet de supprimer un calcul d'habitat pour une ou plusieurs espèce(s) sélectionnée(s).
Outils
Interpolation
Ce sous-onglet de l'onglet 'Outils' permet de réaliser une interpolation des valeurs d'habitat entre les unités de débit ou de temps connus.
Dans un premier temps dans le premier groupe 'Données disponibles', sélectionnez un fichier d'habitat puis un tronçon ainsi qu'une ou plusieurs valeur(s) d'habitat.
Dans un second temps dans le deuxième groupe 'Données souhaitées', créez une chronique à partir d'une séquence ou à partir d'un fichier .txt (contenant une chronique de temps ou de débit).
Une fois l'interpolation réalisée, dans le troisième groupe, vous pouvez visualiser ou exporter les valeurs interpolées.
Hydrosignature
Préambule
Ce sous-onglet de l'onglet 'Outils' permet de réaliser un calcul d'hydrosignature pour tous les tronçons et unités d'un ou plusieurs fichier(s) .hyd ou .hab.
Fichier d'entrée de classes
Pour réaliser un calcul d'hydrosignature à partir d'un ou plusieurs fichiers .hyd ou .hab, un fichier d'entrée de classes est nécessaire.
Exemple de contenu d'un fichier (2classes.txt) :
hw(m) 0.0 0.6 1.2 1.8 2.4 3.0 3.6 4.2 4.8 5.4 v(m/s) 0.0 0.3 0.6 0.9 1.2 1.5 1.8 2.1 2.4 3.0
Mesh manager
Préambule
Fichier de gestion de maille
Horizontal Ramping Rate
Préambule
Fichier HRR
Nouveaux outils à venir
Calcul d’habitat à partir de modèles statistiques
A partir d'Estimhab
A partir de FStress
A partir de Stathab
Propriétés de projet
Préambule
Accessible via : Projet - Propriété ou CTRL+P, le gestionnaire de propriétés de projet permet de changer certaines caractéristiques du projet courant.
Les propriétés de projet sont séparées en 3 groupes :
- Général : propriétés générales ;
- Exports par défaut : activation/désactivation des exports par défaut ;
- Figures : propriété des figures.
Général
- Découpage des mailles hydrauliques partiellement mouillées : Par défaut activé, cette option permet de découper les mailles hydrauliques 2D partiellement mouillées en bordure du lit mouillé du cours d'eau.
- Hauteur d'eau minimale considérée comme nulle (2d) [m] : Par défaut égale à '0.001' m. Cette valeur peut être ajustée par l'utilisateur.
- Écraser si le fichier existe : Par défaut activée, cette option peut être désactivée pour ne pas écraser les fichiers existants (.hyd, sub, .hab ainsi que tous les exports).
Exports par défaut
Par défaut, aucun de ces exports ne sont lancés à la création d'un fichier .hyd ou .hab. Selon vos préférences, vous pouvez les activer spécifiquement.
- Geopackage (.gpkg) Maillage du modèle complet
- Geopackage (.gpkg) Points du modèle complet
- Geopackage (.gpkg) Maillage par unité
- Geopackage (.gpkg) Points par unités
- 3D (.stl) Maillage du modèle complet
- 3D (.pvd, .vtu) Maillage par unité
- avec 3D (.pvd, .vtu) Maillage par unité : choix de la variable 3D.
- 3D vertical exagération : par défaut égale à 10, cette valeur permet d'ajuster l'exagération verticale pour tous les exports 3D.
- Text (.txt) Maillage détaillé
- Text (.txt) Point détaillé
- Text (.pdf) Information des modèles.
Figures
- Taille des figures (l,h) [cm] : largeur et hauteur de figures en centimètre.
- Palette de couleur de carte : liste de choix de palette pour les dégradés de couleur des cartes.
- Taille de police : Taille de la police des figures.
- Famille de police : Famille de police des figures.
- Largeur de ligne : Largeur de ligne en pixel des figures.
- Grille : Active ou désactive une grille horizontale et verticale dans les figures.
- Format de figure : liste de format fichier de figure à l'export.
- Résolution [dpi] : résolution de la figure en dpi.
- Type de nom d'animal : liste type de nom d'animal pour les figures.
- Marqueur (figure habitat) : Afficher ou non les points sur les séries d'habitat.