TELEMAC (Auto-Installation) - Hydro-Informatics

Vorwort¶

Dieses Tutorial führt Sie durch die Installation von open TELEMAC-MASCARET auf Debian Linux und Ubuntu-basierten Systemen mit automatische Installer* Scripten. *Plan für ca. 1-2 Stunden und eine stabile Internetverbindung; die Downloads über 1,4 GB Für detaillierte Installationsanweisungen gehen Sie an die detailed TELEMAC installation page.

Anforderungen¶

Systempakete¶

Debian 12

Ubuntu 24 / Mint 22

Auf Debian 12, fragen Sie Ihren Systemadministrator, ob Sie die folgenden Pakete per aptitude sudo-installieren:

sudo apt update

sudo apt install -y python3-numpy python3-scipy python3-matplotlib python3-pip python3-dev python3-venv libgl1-mesa-glx libegl1-mesa libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6 python-is-python3 git git-lfs gfortran build-essential cmake dialog gedit gedit-plugins libopenmpi-dev openmpi-bin libhdf5-dev hdf5-tools libmetis-dev libmumps-dev libmumps-seq-dev libscalapack-openmpi-dev libmedc-dev libmed-tools python3-pytest-cython python3-sphinx python3-alabaster python3-cftime libcminpack1 python3-docutils python3-h5py python3-imagesize clang python3-netcdf4 python3-nlopt python3-nose python3-numpydoc python3-patsy python3-psutil liblzf1 python3-stemmer python3-sphinx-rtd-theme python3-sphinxcontrib.websupport sphinx-intl python3-statsmodels python3-toml pyqt5-dev pyqt5-dev-tools libboost-all-dev libcminpack-dev libcppunit-dev doxygen libeigen3-dev libfreeimage-dev libgraphviz-dev libjsoncpp-dev liblapacke-dev libxml2-dev llvm-dev libnlopt-dev libnlopt-cxx-dev libqwt-qt5-dev libfontconfig1-dev libglu1-mesa-dev libxcb-dri2-0-dev libxkbcommon-dev libxkbcommon-x11-dev libxi-dev libxmu-dev libxpm-dev libxft-dev libicu-dev libsqlite3-dev libxcursor-dev libtbb-dev libqt5svg5-dev libqt5x11extras5-dev qtxmlpatterns5-dev-tools libpng-dev libtiff-dev libgeotiff-dev libgif-dev libgeos-dev libgdal-dev texlive-latex-base libxml++2.6-dev libfreetype6-dev libgmp-dev libmpfr-dev libxinerama-dev python3-sip-dev tcl-dev tk-dev

Auf Ubuntu 24 (oder Mint 22) fragen Sie Ihren Systemadministrator, ob Sie die folgenden Pakete per Aptitude sudo-installieren:

sudo apt update
sudo apt install -y --no-install-recommends  python3-numpy python3-scipy python3-matplotlib python3-pip python3-dev python3-venv libgl1 libegl1 libxrandr2 libxss1 libxcursor1 libxcomposite1 alsa-base libxi6 libxtst6  python-is-python3 git git-lfs gfortran build-essential cmake dialog gedit gedit-plugins  libmedc11t64 libmedc-dev libmed-tools libmed11 libmed-dev libmedimport0v5 libmedimport-dev  libopenmpi-dev openmpi-bin libhdf5-dev hdf5-tools libmetis-dev libmumps-seq-dev libmumps-dev  libscalapack-openmpi-dev python3-pytest-cython python3-sphinx python3-alabaster python3-cftime  libcminpack1 python3-docutils libfreeimage3 python3-h5py python3-imagesize liblapacke  clang python3-netcdf4 libnlopt0 libnlopt-cxx0 python3-nlopt python3-nose python3-numpydoc  python3-patsy python3-psutil libtbb12 libxml++2.6-2v5 liblzf1 python3-stemmer  python3-sphinx-rtd-theme python3-sphinxcontrib.websupport sphinx-intl python3-statsmodels  python3-toml pyqt5-dev pyqt5-dev-tools libboost-all-dev libcminpack-dev libcppunit-dev  doxygen libeigen3-dev libfreeimage-dev libgraphviz-dev libjsoncpp-dev libxml2-dev  llvm-dev libnlopt-dev libnlopt-cxx-dev libqwt-qt5-dev libfontconfig1-dev libglu1-mesa-dev  libxcb-dri2-0-dev libxkbcommon-dev libxkbcommon-x11-dev libxi-dev libxmu-dev libxpm-dev  libxft-dev libicu-dev libsqlite3-dev libxcursor-dev libtbb-dev libqt5svg5-dev  libqt5x11extras5-dev qtxmlpatterns5-dev-tools libpng-dev libtiff5-dev libgeotiff-dev  libgif-dev libgeos-dev libgdal-dev texlive-latex-base libxml++2.6-dev libfreetype6-dev  libgmp-dev libmpfr-dev libxinerama-dev python3-sip-dev tcl-dev tk-dev

Beachten Sie, dass das automatische Installer-Skript zusätzliche Pakete erkennen kann, die erforderlich sind.

Installationspfade einrichten¶

TELEMAC wird aus dem GitLab-Repository in ein von Ihnen gewähltes Verzeichnis (git-cloned) heruntergeladen und im folgenden als ROOT-Verzeichnis bezeichnet. Außerdem wird SALOME in diesem ROOT-Verzeichnis heruntergeladen und installiert. Wählen Sie eine der folgenden Einstellungen:

Alleinbenutzer ohne Admin-Rechte: ROOT=/home/<USERNAME>/opt (also ROOT=$HOME/opt) (XDG-konforme Alternative: ROOT=$HOME/.local)
Geteilte Nutzung ohne root: nur, wenn bereits ein gruppenbeschreibbarer Standort vorhanden ist, z.B. ein NFS-Aktien wie ROOT=/srv/shared/telemac
Systemweit (admin erforderlich) auf Debian-basierten Systemen: Bevorzugt ROOT=/usr/local (Kombinationen in /usr/local/bin, Bibliotheken in /usr/local/lib); ROOT=/opt ist auch für einen selbstständigen Baum akzeptabel

SALOME¶

Die Wahl der richtigen Version von SALOME kann nicht einfach automatisiert werden, so finden und laden Sie die neueste Version von SALOME und speichern Sie sie im ROOT-Verzeichnis, wo Sie Telemac installieren möchten.

Bestätigen Sie Ihre Linux-Version:

Debian: Katze /etc/os-Release
Mint: lsb_release -a
Ubuntu: inxi -Sx (auch auf Mint)

SALOME-Build herunterladen

Gehen Sie zum offiziellen SALOME-Downloadformular
Wählen Sie die neueste Version mit dem Debian/Ubuntu Build (das entspricht der Ubuntu/Mint-Basis); oder wählen Sie die weniger häufig aktualisierte “Linux Universal”

Überprüfen Sie die Prüfsumme: von SALOMEs md5-Seite, holen Sie die passende .md5-Datei für Ihr Archiv und überprüfen Sie lokal

Beispiel für den 9.15-Terball: md5sum SALOME-9.15.0.tar.gz
Vergleiche mit “SALOME-9.15.0.tar.gz.md5” aus der md5 page - nicht überspringen!

Die Installationsskripte erhalten¶

Debian 12-Benutzer herunterladen telemac debian12 installer.sh und speichern es im ROOT-Verzeichnis.
Mint 22 / Ubuntu 24 Benutzer herunterladen telemac ubuntu24 installer.sh und speichern es im ROOT-Verzeichnis.

Installateure ausführen¶

Installationsmuster¶

Note that you might need admin (sudo) rights for installing additional system packages and that the installation can take a while because the script downloads Telemac. The script installs by default Telemac v9.0.0. To install another version, use the --tag "TAG" option when running the scripts; latest tags can be found at https://gitlab.pam-retd.fr/otm/telemac-mascaret.git.

Um den Installer auszuführen, tippen Sie auf (ersetzen Sie ROOT mit Ihrem ROOT-Verzeichnis und SALOME-x.xx.xSRC.tar.gz mit dem Namen des von Ihnen heruntergeladenen SALOME-Terballs):

Debian 12

Ubuntu 24 / Mint 22

cd ROOT
chmod +x telemac_debian12_installer.sh
./telemac_debian12_installer.sh --root "ROOT" --salome-tar "ROOT/SALOME-x.xx.xSRC.tar.gz"

Nach Abschluss der Installation kann die Telemac-Umgebung wie folgt geladen und zusammengestellt werden:

cd ROOT/telemac-mascaret/configs/
source pysource.debian12.sh
compile_telemac.py --clean

Beachten Sie, dass das Recompiling im Fall des Debian12-Installators notwendig ist (nicht für Ubuntu/Mint erforderlich).

cd ROOT
chmod +x telemac_ubuntu24_installer.sh
./telemac_ubuntu24_installer.sh --root "ROOT" --salome-tar "ROOT/SALOME-x.xx.xSRC.tar.gz"

Nach Abschluss der Installation kann die Telemac-Umgebung wie folgt geladen werden:

cd ROOT/telemac-mascaret/configs/
source pysource.mint22.sh

Die Installer-Skripte werden den telemac-mascaret GitLab repo (mit dem zugewiesenen Tag) und einen salome-Ordner klonen, in dem er den SALOME-Terball auspackt. Wenn Sie mit SALOME Fehler machen, überprüfen Sie im Abschnitt die detailed SALOME installation instructions auf der “manuellen” Installation von Telemac.

Um die Installation zu testen, führen Sie das Skript config.py (nach Quellung der Telemac-Umgebung):

config.py

Installationsbeispiel¶

Angenommen, Sie arbeiten an Debian 12, entsprechend haben Sie SALOME-9.15.0-native-DB12-SRC.tar.gz heruntergeladen, das ROOT-Verzeichnis als /home/HyInfo/opt/ definiert und telemac_debian12_installer.sh heruntergeladen. So kann die Installation mit diesen Befehlen gestartet werden:

cd /home/HyInfo/opt
chmod +x telemac_debian12_installer.sh
./telemac_debian12_installer.sh --root "/home/HyInfo/opt" --salome-tar "/home/HyInfo/opt/SALOME-9.15.0-native-DB12-SRC.tar.gz" --salome-md5 "/home/HyInfo/opt/SALOME-9.15.0-native-DB12-SRC.tar.gz"

Aktivieren Sie nun die Telemac-Umgebung und kompilieren Sie wie folgt:

cd /home/HyInfo/opt/telemac-mascaret/configs/
source pysource.debian12.sh
compile_telemac.py --clean

Installationsbeispiel mit einer anderen Version¶

Angenommen, Sie arbeiten an Debian 12, dementsprechend haben Sie SALOME-9.15.0-native-DB12-SRC.tar.gz heruntergeladen, das ROOT-Verzeichnis als /home/HyInfo/opt/, heruntergeladen telemac_debian12_installer.sh definiert und möchten ** Telemac v9.5.0*** installieren (wenn es unter https://gitlab.pam-retd.fr/otm/telemac-mascaret.git existiert). Diese Installation kann mit diesen Befehlen gestartet werden:

cd /home/HyInfo/opt
chmod +x telemac_debian12_installer.sh
./telemac_debian12_installer.sh --root "/home/HyInfo/opt" --tag="v9.5.0" --salome-tar "/home/HyInfo/opt/SALOME-9.15.0-native-DB12-SRC.tar.gz" --salome-md5 "/home/HyInfo/opt/SALOME-9.15.0-native-DB12-SRC.tar.gz"

Aktivieren Sie nun die Telemac-Umgebung und kompilieren Sie Telemac wie folgt:

cd /home/HyInfo/opt/telemac-mascaret/configs/
source pysource.debian12.sh
compile_telemac.py --clean

Re-Install¶

Um eine bestehende Installation zu fixieren/zu installieren:

Navigieren Sie zu Ihrem TELEMAC-Verzeichnis:

cd ~/opt/telemac-mascaret

Führen Sie den Installer mit --skip-apt um Konfiig-Dateien zu regenerieren (begründet, dass Sie eine neuere Version des Installer-Skripts verwenden)

chmod +x ./telemac_debian12_installer.sh
./telemac_debian12_installer.sh --skip-apt --root "/ROOTDIR" --salome-tar "ROOT/SALOME-x.xx.xSRC.tar.gz"

Regenerate von re-running config und compile:

source configs/pysource.debian12.sh
compile_telemac.py --clean

Prüfung TELEMAC¶

** Geschätzte Dauer: 5-10 Minuten.***

Laden Sie die TELEMAC-Umgebung:

Debian 12

Ubuntu 24 / Mint 22

cd ROOT/telemac-mascaret/configs/
source pysource.debian12.sh

Führen Sie einen vordefinierten Fall aus dem Ordner examples aus:

cd ~/opt/telemac-mascaret/examples/telemac2d/gouttedo
telemac2d.py t2d_gouttedo.cas

Um die Parallelität zu überprüfen, installieren Sie htop, um die CPU-Nutzung zu visualisieren:

sudo apt update
sudo apt install htop

Starten Sie den CPU-Monitor:

htop

In einem neuen Terminal-Tab führen Sie ein TELEMAC-Beispiel mit der --ncsize=Nfahne, wobei N die Anzahl der logischen CPUs ist, die verwendet werden sollen (mindestens N stehen zur Verfügung):

cd ~/opt/telemac-mascaret/examples/telemac2d/gouttedo
telemac2d.py t2d_gouttedo.cas --ncsize=4

Alternativ verwenden Sie --nctile und --ncnode, um Kerne pro Knoten (NCTILE) und Anzahl der Knoten (NCNODE) mit NCSIZE = NCTILE * NCNODE anzugeben. Die folgenden beiden Befehle sind gleichwertig (von ~/opt/telemac-mascaret/examples/telemac2d/donau):

telemac2d.py t2d_donau.cas --nctile=4 --ncnode=2
telemac2d.py t2d_donau.cas --ncsize=8

Got errors?

Wenn es schwere Fehler gibt, hat der automatische Installer möglicherweise nicht für Ihr System (oder Subversion) gearbeitet. In diesem Fall ist es sicher, zu starten und install Telemac manually.

TELEMAC generieren Dokumentation¶

TELEMAC enthält viele Anwendungsbeispiele unter /telemac-mascaret/examples/ und Sie können die Benutzer- und Referenzhandbücher lokal erstellen. Zuerst die TELEMAC-Umgebung laden:

source ~/opt/telemac-mascaret/configs/pysource.mint22.sh

Um das Benutzerhandbuch zu generieren (dies kann eine Weile dauern und erfordert Latex, d.h. texlive auf Debian/Ubuntu):

doc_telemac.py

Um das Referenzhandbuch zu erzeugen:

doc_telemac.py --reference

Um Dokumentations- und Validierungsberichte für alle Beispielfälle zu erstellen:

validate_telemac.py

Utilities (Vor- und Nachbearbeitung)¶

Um Vor- und Nachbearbeitungsprogramme zu installieren, finden Sie die Anweisungen im manual installation section, wie BlueKenue oder dem Q4TS-Plugin in QGIS. Beachten Sie, dass für das Q4TS-Plugin Ihr SALOME ausführbarer Pfad /ROOT/salome/salome ist und Ihr Telemac environnement-Skript /ROOT/telemac-mascaret/configs/pysource.debian12.sh (oder /ROOT/telemac-mascaret/configs/pysource.mint22.sh wenn Sie auf Ubuntu/Mint installiert sind).