Add README SWASH

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
+```