Diese Seite wurde maschinell aus dem Englischen übersetzt und kann Fehler enthalten. Englisches Original

Terminalsyntax

Das QGIS-Plugin und das Terminal verwenden das gleiche Programm. Eine Simulation, die von einem Terminal gestartet wird, erzeugt daher die gleichen Dateien wie eine, die vom Plugin gestartet wird, und beide erscheinen in der Jobliste des anderen.

Wichtig

Ein Terminal zeigt weder die Eingabe Layer noch die Ergebnisse an. Öffnen Sie die Geodaten in QGIS vor dem ersten Durchlauf, um zu überprüfen, ob die Layer zusammenpassen (Geodaten), und überprüfen Sie die Ergebnisse jedes Schritts auf einer Karte, bevor der nächste Schritt gestartet wird. Ein Modell kann ohne Fehlermeldung laufen und trotzdem falsch liegen, zum Beispiel weil eine Zufluss-Zeile an der falschen Stelle liegt.

Öffnen Sie ein Terminal

Öffnen Sie bei Linux ein Terminal und aktivieren Sie die Python-Umgebung, in der aXqua installiert ist:

mamba activate axqua-env
axqua --version

Öffnen Sie bei Windows das Miniforge Prompt aus dem Startmenü und geben Sie die gleichen zwei Befehle ein. Wenn die Simulationssoftware im Windows-Subsystem für Linux installiert ist, öffnen Sie stattdessen die Terminal der Linux-Distribution und fahren Sie wie unter Linux fort.

Befehle

Ein Befehl besteht aus dem Programmnamen, einer Aktion und für die meisten Aktionen der Fall-Datei:

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

Einrichten des Computers (Plugin Setup):

Kommando

Funktion

axqua profile init

Erstellen Sie das Profil des Computers aus der darauf befindlichen Software.

axqua profile check

Überprüfen Sie das Profil, einschließlich, ob TELEMAC und OpenFOAM gestartet werden können.

axqua profile show

Drucken Sie das verwendete Profil aus.

axqua profile locate telemac <folder>

Drucken Sie das Umgebungsskript, das aXqua im Installationsordner von TELEMAC findet. Die anderen Programme sind openfoam, paraview und visit. Geben Sie den Ordner im Block installations des Profils ein.

Installation der Simulationssoftware (Simulationssoftware):

Kommando

Funktion

axqua install

Zeigen Sie das erkannte Betriebssystem und für TELEMAC OpenFOAM und die Postprozessoren an, wo jeder installiert ist.

axqua install plan telemac

Zeigen Sie, was die Installation tun würde, welche Systempakete fehlen und den Befehl, der sie installiert. Nichts wird geändert. Die anderen Programme sind openfoam und postprocessors.

axqua install start telemac

Starten Sie die Installation als eigenen Prozess und geben Sie das Ergebnis im Profil ein. Fügen Sie --foreground hinzu, um der Installation im Terminal zu folgen. --folder wählt den Installationsordner aus. Für openfoam und postprocessors lässt --no-visit VisIt aus.

axqua install status telemac --tail 20

Zeigen Sie den Zustand der Installation und die letzten Zeilen des Logs an.

axqua install cancel telemac

Stoppen Sie die Installation. Was bereits heruntergeladen und gebaut wurde, wird beibehalten.

axqua install telemac-examples <folder>

Laden Sie die Eingabedateien des Beispiels Fälle eines installierten TELEMAC herunter, die noch fehlen. <folder> ist der Ordner telemac-mascaret der Installation.

Vorbereitung und Überprüfung eines Falls:

Kommando

Funktion

axqua check <case-file>

Melden Sie alles in der Fall-Datei, das nicht in Ordnung ist: fehlende Dateien, unbekannte oder unmögliche Einstellungen und Einstellungen, die noch leer sind. Der Befehl listet alle Probleme auf einmal auf.

axqua <case-file> --check

Überprüfen Sie die Fall-Datei, die Eingabedateien und die Simulationssoftware und stoppen Sie beim ersten Problem.

axqua case new <case-file>

Erstellen Sie eine Fall-Datei mit den Einträgen, die jeder Fall hat.

axqua example list

Listen Sie das Beispiel Fälle mit ihrer Größe (Beispielfall).

axqua example get --folder <folder>

Laden Sie das Beispiel Fall in <folder> herunter: die Fall-Datei, die Eingabedaten und ein Handbuch. Mit mehreren Beispielen, benennen Sie das Beispiel vor --folder.

axqua <case-file>

Führen Sie Preprocessing aus und schreiben Sie das TELEMAC-Modell.

axqua <case-file> --dry-run

Führen Sie Preprocessing aus und starten Sie TELEMAC einmal, um zu überprüfen, ob es das Modell akzeptiert.

axqua surface <case-file>

Konvertieren Sie CAD-Dateien in Gelände und Layer eines Fall.

axqua status <case-file>

Zeigen Sie, welche Simulationen konfiguriert, erstellt und ausgeführt werden.

axqua openfoam <case-file> --check

Zeigen Sie die Anzahl der Zellen des OpenFOAM Rechennetzes an, ohne es zu erstellen.

axqua targets <case-file>

Erstellen Sie die Arbeitsmappe für Feldmessungen.

axqua check-gt <case-file>

Vergleichen Sie die Höhen der Messpunkte mit dem Gelände-Modell.

axqua postproc <case-file>

Rendern Sie die vordefinierten Figuren mit VisIt.

Ergebnisse für ParaView und VisIt (Postprocessing):

Kommando

Funktion

axqua export <case-file> --list

Listen Sie die TELEMAC-Ergebnisse des Falls mit ihren Zeitschritten auf und geben Sie an, welche von ihnen exportiert werden.

axqua export <case-file>

Konvertieren Sie die TELEMAC-Ergebnisse des Falls in Dateien, die ParaView (.pvd) und VisIt (.visit) öffnen. --result r2d.slf wählt ein Ergebnis aus und --frames last nur seinen letzten Zeitschritt.

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

Konvertieren Sie eine Ergebnisdatei ohne Fall. Die Geometriedatei des Modells liefert die genauen Knoten-Koordinaten.

Instrumente für Eingabedaten:

Kommando

Funktion

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

Schneiden Sie ein Raster, zum Beispiel ein DGM, zu einem Polygon.

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

Schätzen Sie eine Abflusskurve von Gerinne Breite, Betthang und Rauheit.

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

Schreibe eine Fall Datei des aktuellen Typs (.axq-case) neben eine Fall Datei einer älteren aXqua Version.

Speicherplatz und Dokumentation:

Kommando

Funktion

axqua cleanup <case-file>

Listen Sie die Dateien eines Falls auf, die nichts mehr braucht, nach Kategorie und mit ihrer Größe. Nichts wird entfernt (Freigeben des Scheibenraums).

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

Entfernen Sie die aufgeführten Elemente mit diesen Identifikatoren. --category <key> entfernt alle Elemente einer Kategorie, --keep every:10 behält jeden zehnten Zeitschritt eines Ergebnisses statt nur des letzten.

axqua docs

Benennen Sie die Kopie dieser Dokumentation auf diesem Computer, die Help im Plugin geöffnet wird, und die veröffentlichte Adresse.

Simulationen als Jobs ausführen (Batch-processing (Kopflos)):

Kommando

Funktion

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

Starten Sie eine Simulation als Job und drucken Sie ihre ID aus.

axqua submit <case-file> --kind validation

Führen Sie das kalibrierte Modell für die Validierungssituation des Falls aus und vergleichen Sie es mit den Validierungsdaten (Validierungslauf). axqua validation <case-file> listet die Validierungssituationen, die Zuflüsse des Modells und die Ergebnisse früherer Validierungen auf.

axqua list

Liste alle Jobs auf.

axqua status <job-id>

Zeigen Sie den Zustand und den Fortschritt eines Jobs.

axqua logs <job-id> --follow

Zeigen Sie das Protokoll eines Jobs, während er läuft.

axqua cancel <job-id>

Beenden Sie einen Job und alle Prozesse, die er gestartet hat.

Jeder Befehl erklärt seine Optionen mit --help, zum Beispiel axqua submit --help.

Optionen für Skripte

Mit der Option --json druckt jeder Befehl sein Ergebnis als ein JSON-Dokument aus, das andere Programme zuverlässig lesen können. Wenn ein Befehl fehlschlägt, zeigt der Exit-Code die Ursache an, so dass ein Skript reagieren kann, ohne die Nachricht zu lesen:

Ausstiegscode

Ursache

0

Erfolgreich

2

Fehler in der Fall-Datei

3

Fehler in den Geodaten

4

Simulationssoftware nicht erreichbar

5

Die Simulation scheiterte

6

Das Rechennetz konnte nicht geschaffen werden

1

Sonstige Fehler

130

Vom Benutzer storniert

Skripte im Fall Ordner

Der Vorlagenordner cases/case-template/ des Repositorys enthält pro Arbeitsschritt ein Python-Skript, z. B. preprocessing.py, initial_run.py und mesh_convergence_study.py. Sie führen die gleichen Schritte wie die obigen Befehle aus und laufen im Vordergrund, so dass die Ausgabe des Simulationscodes direkt im Terminal erscheint. Einstellungen, die nur für einen Schritt gelten, werden oben in jedem Skript aufgeführt. Die Skripte sind Teil einer Kopie des Repositorys (Installieren aus dem Quellcode (Entwicklung)), nicht des installierten Programms.

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