Cette page a été traduite automatiquement de l’anglais et peut contenir des erreurs. Original en anglais

Syntaxe Terminal

L’extension QGIS et le terminal utilisent le même programme. Une simulation qui est lancée à partir d’un terminal produit donc les mêmes fichiers que l’un qui est lancé à partir de l’extension, et les deux apparaissent dans la liste tâche de l’autre.

Important

A terminal ne montre ni les couches d’entrée ni les résultats. Ouvrez les géodonnées de QGIS avant la première course pour vérifier que les couches s’alignent ensemble (Géodonnées), et vérifiez les résultats de chaque étape sur une carte avant de commencer la prochaine étape. Un modèle peut fonctionner sans message d’erreur et se tromper encore, par exemple parce qu’une ligne d’entrée se trouve au mauvais endroit.

Ouvrir un terminal

Sur Linux, ouvrez un terminal et activez l’environnement Python dans lequel aXqua est installé :

mamba activate axqua-env
axqua --version

Sur Windows, ouvrez le Miniforge Prompt à partir du menu de départ et entrez les mêmes deux commandes. Si le logiciel de simulation est installé dans le sous-système Windows pour Linux, ouvrez plutôt le terminal de la distribution Linux et continuez comme sur Linux.

Commandes

Une commande se compose du nom du programme, d’une action et, pour la plupart, du fichier de cas :

axqua <action> <case-file> [options]

Configuration de l’ordinateur (Configuration de l’extension) :

Commande

Fonction

axqua profile init

Créez le profil de l’ordinateur à partir du logiciel qui y est trouvé.

axqua profile check

Vérifier le profil, y compris si TELEMAC et OpenFOAM peuvent être démarrés.

axqua profile show

Imprimer le profil utilisé.

axqua profile locate telemac <folder>

Imprimer le script d’environnement qu’aXqua trouve dans l’installation dossier de TELEMAC. Les autres programmes sont openfoam, paraview et visit. Entrez le dossier dans le bloc installations du profil.

Installer le logiciel de simulation (Logiciel de simulation) :

Commande

Fonction

axqua install

Afficher le système d’exploitation détecté et, pour TELEMAC, OpenFOAM et les postprocesseurs, où chacun est installé.

axqua install plan telemac

Afficher ce que l’installation ferait, quels paquets système manquent, et la commande qui les installe. Rien n’est changé. Les autres programmes sont openfoam et postprocessors.

axqua install start telemac

Commencez l’installation comme un processus propre et entrez le résultat dans le profil. Ajouter --foreground pour suivre l’installation dans le dossier terminal. --folder sélectionne l’installation. Pour openfoam et postprocessors, --no-visit quitte VisIt.

axqua install status telemac --tail 20

Affiche l’état de l’installation et les dernières lignes de son journal.

axqua install cancel telemac

Arrêtez l’installation. Ce qui est déjà téléchargé et construit est conservé.

axqua install telemac-examples <folder>

Télécharger les fichiers d’entrée de l’exemple cas d’un TELEMAC installé qui sont toujours manquants. <folder> est le dossier telemac-mascaret de l’installation.

Préparation et vérification d’un cas :

Commande

Fonction

axqua check <case-file>

Signalez tout dans le fichier de cas qui n’est pas dans l’ordre : les fichiers manquants, les paramètres inconnus ou impossibles, et les paramètres qui sont toujours vides. La commande énumère tous les problèmes à la fois.

axqua <case-file> --check

Vérifiez le fichier de cas, les fichiers d’entrée et le logiciel de simulation, et arrêtez au premier problème.

axqua case new <case-file>

Créez un fichier de cas avec les entrées que chaque cas a.

axqua example list

Énumérez l’exemple cas avec sa taille (Exemple cas).

axqua example get --folder <folder>

Téléchargez l’exemple cas dans <folder>: le fichier de cas, les données d’entrée et un guide. Avec plusieurs exemples, nommer l’exemple avant --folder.

axqua <case-file>

Exécutez le prétraitement et écrivez le modèle TELEMAC.

axqua <case-file> --dry-run

Lancez le prétraitement et lancez TELEMAC une fois, pour vérifier qu’il accepte le modèle.

axqua surface <case-file>

Convertissez les fichiers CAO dans le terrain et couches d’un cas.

axqua status <case-file>

Afficher quelles simulations sont configurées, construites et exécutées.

axqua openfoam <case-file> --check

Afficher le nombre de cellules de l’OpenFOAM maillage sans le construire.

axqua targets <case-file>

Créez le cahier pour mesures de terrain.

axqua check-gt <case-file>

Comparez les élévations des points de mesure avec le modèle de terrain.

axqua postproc <case-file>

Renvoyez les chiffres prédéfinis avec VisIt.

Résultats pour ParaView et VisIt (Post-traitement) :

Commande

Fonction

axqua export <case-file> --list

Énumérez les résultats TELEMAC du cas avec leur pas de temps, et indiquez lequel d’entre eux est exporté.

axqua export <case-file>

Convertissez les résultats TELEMAC du cas en fichiers que ParaView (.pvd) et VisIt (.visit) ouvrent. --result r2d.slf sélectionne un résultat, et --frames last seulement son dernier pas de temps.

axqua export <result.slf> --geometry <geometry.slf>

Convertir un fichier de résultat sans cas. Le fichier géométrique du modèle fournit les coordonnées exactes de nœud.

Outils pour les données d’entrée :

Commande

Fonction

axqua clip <raster> -b <polygon> -o <output>

Couper un raster, par exemple un MNT, en polygone.

axqua rating -o <output.csv> ...

Estimez une courbe de tarage de la largeur chenal, la pente du lit et la rugosité.

axqua migrate <old-file> --to-case

Écrire un fichier de cas du type actuel (.axq-case) à côté d’un fichier de cas d’une ancienne version aXqua.

Espace disque et documentation :

Commande

Fonction

axqua cleanup <case-file>

Énumérez les fichiers d’un cas qui n’ont plus besoin de rien, par catégorie et avec leur taille. Rien n’est supprimé (Libérer l’espace disque).

axqua cleanup <case-file> --remove <id> ...

Supprimer les éléments énumérés avec ces identifiants. --category <key> supprime tous les éléments d’une catégorie, --keep every:10 garde chaque dixième pas de temps d’un résultat au lieu du dernier seulement.

axqua docs

Nommez la copie de cette documentation construite sur cet ordinateur, qui Help dans l’extension s’ouvre, et l’adresse publiée.

Simulations en mode tâches (Batch-processing (sans tête)) :

Commande

Fonction

axqua submit <case-file> --kind <kind>

Commencez une simulation en tâche et imprimez son ID.

axqua submit <case-file> --kind validation

Lancer le modèle étalonné pour la situation de validation du cas et le comparer avec les données de validation (exécution de validation). axqua validation <case-file> liste les situations de validation, les entrées du modèle et les résultats des validations antérieures.

axqua list

Liste toutes les tâches.

axqua status <job-id>

Montrez l’état et le progrès d’une tâche.

axqua logs <job-id> --follow

Afficher le journal d’une tâche pendant son fonctionnement.

axqua cancel <job-id>

Arrêtez une tâche et tous les processus qu’elle a commencés.

Chaque commande explique ses options avec --help, par exemple axqua submit --help.

Options pour les scripts

Avec l’option --json, chaque commande imprime son résultat comme un document JSON, que d’autres programmes peuvent lire de façon fiable. Si une commande échoue, son code de sortie indique la cause, de sorte qu’un script puisse réagir sans lire le message :

Code de sortie

Cause

0

Succès

2

Erreur dans le fichier de cas

3

Erreur dans les données géographiques

4

Logiciel de simulation inaccessible

5

La simulation a échoué

6

Le maillage n’a pas pu être créé

1

Toute autre erreur

130

Annulé par l’utilisateur

Scripts dans le dossier cas

Le modèle dossier cases/case-template/ du dépôt contient un script Python par étape de travail, par exemple preprocessing.py, initial_run.py et mesh_convergence_study.py. Ils effectuent les mêmes étapes que les commandes ci-dessus et courent au premier plan, de sorte que la sortie du code de simulation apparaît directement dans le terminal. Les paramètres qui s’appliquent à une seule étape sont listés en haut de chaque script. Les scripts font partie d’une copie du dépôt (Installer à partir du code source (développement)), pas du programme installé.

cd cases/my-reach
python preprocessing.py
python initial_run.py