Utilisation_Plugin - Artelia/Mascaret GitHub Wiki

1. Présentation de la fenêtre principale du plugin

Pour ouvrir le plugin en vue d'une utilisation, il faut :

  • Cliquer sur le bouton icon_base.png dans la barre d'outils
  • Dans la fenêtre qui s'ouvre, choisir la base de donnée dans laquelle on veut travailler dans la liste déroulante située en bas à gauche de la fenêtre.
  • un message « connexion etablished » apparaît alors.

Ne pas fermer cette fenêtre tant qu'on travaille dans cette base de données.

main_windows_fr.png

À ce stade, certains des différents onglets sont inactifs, mais ils contiennent les différents outils disponibles pour tout travail de modélisation.

  • L'onglet Database permet d'interagir avec la base de données. On peut donc rafraîchir la connexion refreshConnections.png, créer dbCreateModel.png, charger dbloadModel.png ou encore supprimer un modèle dbDeleteModel.png, exporter dbExtractModel.png ou importer dbImportModel.png un modèle.

⚠️ Attention :

    Si Postgres n'est pas en local, la fonctionnalité d'export ne sera pas disponible depuis le plugin. Il faudra passer par pgAdmin pour cela.


  • L'onglet Tools est relatif aux profils en travers et informations relatives

  • L'onglet Run permet quant à lui de définir les paramètres parameter.png de l'étude (fluvial, permanent ou transcritique), de créer un fichier .geo geo.png, .xcas xcas.png, casier basin.png ou l'ensemble des fichier du modèle Model.png (cf. 4.8 Fichiers Mascaret), puis de lancer des runs play.png, d'exporter le dernier run repSav.png ou de supprimer un run croix.png.

  • L'onglet Post traitement permet de voir les résultats des runs sur le site d'étude

Sans passer par les menus décrit juste avant, les différentes fonctions sont accessibles grâce à des raccourcis sous forme de pictogrammes dans la barre d'outils.

bar_tools.png

En utilisant ces "outils" on peut modifier les différentes couches d'un modèle contenu dans un projet. Les données nécessaires au modèle sont stockées dans la base :

  • lors d'une modification de paramètre via le plugin
  • lorsqu'on sort une couche du mode édition. Fenêtre Qgis « Arrêter l'édition : Voulez-vous enregistrer les modifications pour la couche …? »
    • Save pour sauver
    • Discard pour ne pas sauver
    • Cancel pour annuler la sortie du mode édition

L'enregistrement du projet QGis n'est pas obligatoire, sauf pour garder les couches externes à Mascaret comme le MNT, etc.

2. Les éléments d'un modèle

Que l'on crée ou ouvre un modèle déjà existant (voir plus bas), différentes couches s'affichent dans l'interface graphique de QGIS. Il s'agit de la couche :

  • le groupe « Mas_nomduprojet » regroupe tous les éléments du modèle,
  • les extrémités libres du modèle auxquelles doivent être fournies les conditions limites du modèle,
  • les branches (ou réseau filaire) qui permettent le référencement linéaire des objets le long de celui-ci. Historiquement (jusqu'à la version 5.0.9), les branches se différencient en zones par les coefficients de Strickler, maillage et planimétrage.
  • les profils en travers hydrauliques pour renseigner la géométrie du site ainsi que les limites lits mineur et majeurs du cours d'eau et zones de stockage. Depuis la version 5.1.1, le profil en travers porte les informations attributaires coefficients de Strickler, maillage et planimétrage.
  • la topographie qui stocke les points de relevés topo et bathymétriques de géomètre (couche de bancarisation de la donnée topo-bathymétrique sans utilisation hydraulique directe)
  • les différentes singularités (seuils, barrages) présentes sur le site d'étude,
  • les laisses des crues qui peuvent être associés à un événement,
  • les points de sorties qui sont des points de calculs où il est possible de comparer observations et prévisions,
  • les apports, ponctuels ou diffus (linéaires),
  • les pertes de charges singulières,
  • les casiers et leurs liaisons,
  • tous les objets peuvent être activés/désactivés.

Ce sont donc les couches à remplir (ou modifier) lors de la création d'un nouveau projet ou de l'utilisation d'un projet existant.

3. Gestion des projets (modèles)

3.1. Ouverture d'un projet existant

On peut ouvrir un projet existant, par exemple le projet Masc_modele_oise contenant le modèle sur l'oise « modele_oise » : Database -> dbImportModel.png Import model

Le message « import is done » s'affiche dans la fenêtre après importation. Le projet étant importé, on peut dorénavant charger le modèle qu'il contient

3.2. Ouverture d'un modèle contenu dans un projet existant

Exemple : Database -> dbloadModel.png Load model -> modele_oise

Un message précise qu'on travaille sur le schéma modele_oise. Celui-ci s'affiche dans l'interface graphique de Qgis.

qgis_windows.png

3.3. Créer un nouveau modèle

Pour créer un nouveau modèle Database -> dbCreateModel.png Create New model

Choisir un nom (sans accent ni caractères spéciaux).

Un groupe de couches se crée avec le nom du modèle et l'ensemble des couches nécessaire à la création du modèle.

Deux tables sont également présentes contenant les lois du modèle ("laws") et les événements ("events"). La construction du modèle passera par le remplissage de ces différentes couches.

qgis_windows_tables.png

3.4. Travail sur un modèle depuis différents postes

Pour ouvrir le modèle depuis un autre poste sur lequel le plugin Mascaret est installé, il y a deux solutions.

  • partager la même base Postgres (accès à distance) : voir Installation
  • exporter puis importer le modèle : voir paragraphes suivants : § 3.5. et § 3.6.

3.5. Exporter un modèle

Pour exporter le modèle, il y a deux façons :

  • cliquer sur le bouton dbExtractModel.png. Possible si le serveur postgres est en local sur le PC, mais pas s'il est à distance

  • export d'un backup depuis pgAdmin : suivre procédure « BACKUP dans Pgadmin 4 » décrite par la suite. Notez que l'importation se fera également dans Pgadmin 4.

GUI dbExtractModel.png

Lorsque vous cliquez sur le bouton, une interface graphique s'ouvre vous permettant de choisir si vous voulez enregistrer l'ensemble des résultats (il faut cocher la case "Export all Results") ou juste certains (en cochant les scénarios que vous voulez), ou bien encore aucun résultat (si rien n'est coché).

export1.png

Puis cliquez sur le bouton "Export" pour que l'exportation se fasse. Cela générera deux fichiers. Le premier fichier est un fichier métadata que nous utiliserons lors des importations. Il contient :

  • la version du plugin
  • la version de PostgreSQL
  • le nom du schéma
  • la date d'export
  • le nom du schéma contenu dans le fichier *.psql

Le second fichier contient les information PostgreSQL.

BACKUP dans Pgadmin 4

Au préalable, supprimer les résultats de simulations pour réduire la taille du fichier backup.

  • Pour cela deux solutions possibles :
    • depuis le plugin Mascaret avec le bouton croix.png (voir § 5.7)
    • vider les valeurs des tables suivantes depuis pgAdmin : runs, results, results_sect, results_var, run_graph et si la base de donnée a été créée avec une ancienne version du plugin, il faut également le faire avec les tables resultats, resultats_basin et resultats_links
      Pour chaque table, cliquer doit > Truncate> Truncate, OK

postgres_export1.png

  • Cliquer droit sur le modèle dans la rubrique "Schemas" puis cliquer sur "Backup"

postgres_import1.png

  • Onglet "General" : * Filename : choisir un nom en ".sql" ou ".backup" et l'emplacement du fichier en cliquant sur « ... » * Format : "Tar" * Encoding : "UTF8" * Role name : saisir le user d'authentification métier (s'il existe) au serveur postgres. Exemple : "mascaret" (sinon "postgres", qui est le user qui a tous les droits)
    • Onglet "Dump options", choisir Yes pour Pre-data, Data, et Post-data

postgres_import2.png

  • cliquer sur "Backup" en bas à droite de la fenêtre

=> On obtient le fichier désiré.

3.6. Importer un modèle

Pour importer le modèle, il y a deux façons :

  • cliquer sur le bouton dbImportModel.png
  • import d'un backup depuis pgAdmin : suivre procédure « RESTORE dans Pgadmin 4 » décrite par la suite.

GUI dbImportModel.png

Lorsque vous cliquez sur l'importation une interface graphique s'ouvre (voir image ci-dessous).

import1.png

En cliquant sur le bouton ayant "...", il est possible de choisir le fichier à importer. Celui a sélectionné est le fichier métadata (*.json).

Après la sélection du fichier, les champs "Model Name", "Plugin Version" et "Postgres Version" sont affichés. Les valeurs des champs pourront se colorer en 3 couleur :

  • Vert: Ok pour l'importation
  • Orange: l'importation sera possible mais des actions seront à mener.
  • Rouge: l'importation est impossible

Pour le "Model Name" :

  • Vert : Il n'y aura pas de conflit pour le nom du modèle
  • Orange : lors de l'importation, il sera demandé si vous voulez écraser ou importer le modèle avec un autre nom

Pour le "Plugin version" :

  • Vert : le modèle vient d'une version du plugin similaire
  • Orange : le modèle vient d’une version antérieure du plugin. Il faudra alors le mettre à jour à son ouverture.
  • Rouge : le modèle vient d'une version plus récente du plugin. Il faudra alors mettre à jour son plugin avant l'importation

Pour le "Postgres Version" :

  • Vert : importation possible
  • Rouge: importation impossible sans doute à cause d'un PostgreSQL trop ancien par rapport à celui utilisé pour l'exportation.

« RESTORE dans Pgadmin 4 »

  • Créer un nouveau modèle : cliquer droit sur la rubrique Schemas -> Create -> Schema. Compléter le nom (Name) et cliquer sur Save.

postgres_import1.png

  • Sélectionner le modèle que vous souhaitez mettre à jour, a priori celui qui vient d'être créé (il sera écrasé par le modèle importé).
  • Cliquer droit sur le modèle dans la rubrique Schéma puis cliquer sur "Restore"

postgres_import2.png

  • Onglet 'General' :
    • Format : "Custom or tar"
    • Filename : choisir le fichier en ".sql" ou ".backup" à restaurer
    • Role name : saisir le user d'authentification métier (s'il existe) au serveur postgres. Exemple : "mascaret" (sinon "postgres", qui est le user qui a tous les droits)
  • Onglet "Restore options", choisir Pre-data, Data, et Post-data et Clean before restore

postgres_import3.png

  • cliquer sur "Restore" en bas à droite de la fenêtre

A la fin, pensez à mettre à jour les bases de données de modèles fabriqués avec une autre version du plugin : § 3.7

3.7. Mise à jour de la base de données d'un modèle

Lors d'un chargement de modèle construit à partir d'une autre version du plugin que celle installée sur le poste actuellement, une fenêtre demande l'autorisation de mettre à jour le modèle. postgres_import3.png

Il est possible de refuser la mise à jour pour faire un export de sauvegarde de votre modèle avant de recharger le modèle pour accepter la mise à jour automatique.

3.8. Reconstruction des tables de la base de donnée

Dans le menu "Database", il y a la possibilité de reconstruire les tables ("Rebuild table (vacuum full)) ce qui permet de libérer la place mémoire non utilisée. Il faut cependant noter que cela peut prendre plusieurs minutes si la base de donnée est importante.


⚠️ Attention :

    Il ne faut pas interrompre la reconstruction des tables.


3.9. Clonage d'un modèle

L'option "To clone model" sous le menu "Database" permet de cloner un modèle sans les résultats associés dans la base de données.


💡 Astuce :

    Cette option permet de faire une sauvegarde d'un état d'avancement de la construction d'un modèle de manière simplifiée dans la base de donnée ou simplement de faire une copie d'un modèle pour effectuer des tests


⚠️ **GitHub.com Fallback** ⚠️