From 479230840be322a140a2ab407f49e2131cb32011 Mon Sep 17 00:00:00 2001 From: "Edgar P. Burkhart" Date: Wed, 6 Jul 2022 10:06:18 +0200 Subject: [PATCH] Add README SWASH --- swash/README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 swash/README.md diff --git a/swash/README.md b/swash/README.md new file mode 100644 index 0000000..58f9b68 --- /dev/null +++ b/swash/README.md @@ -0,0 +1,36 @@ +# SWASH + +Ce dossier regroupe l'ensemble des scripts nécessaires à l'éxécution du modèle SWASH ainsi qu'au post-traitement des +données. + +## Scripts + +### Animate + +`animate.py` permet d'obtenir une animation des résultats de SWASH. + +```python -m processing.animate [-c CONFIG]``` + +* `-c CONFIG` : choix du fichier de configuration + +``` +[post] +inp : dossier contenant les données d'entrée +out : dossier de sortie +``` + +### Mat Npz + +`mat_npz` permet de convertir les données de sortie de SWASH en données Numpy plus facile à exploiter en Python. + +```python -m processing.mat_npz [-c CONFIG]``` + +* `-c CONFIG` : choix du fichier de configuration + +``` +[swash] +out : dossier de sortie de swash + +[post] +inp : dossier de sortie pour les données numpy +```