From e7316717f7580c31a675a008188316b764f4b526 Mon Sep 17 00:00:00 2001
From: "Edgar P. Burkhart" <git@edgarpierre.fr>
Date: Wed, 6 Jul 2022 09:03:13 +0200
Subject: [PATCH] Update README, animate

---
 olaflow/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 olaflow/README.md

diff --git a/olaflow/README.md b/olaflow/README.md
new file mode 100644
index 0000000..5805740
--- /dev/null
+++ b/olaflow/README.md
@@ -0,0 +1,16 @@
+# Olaflow
+
+Ce dossier regroupe l'ensemble des scripts nécessaires à l'éxécution du modèle Olaflow ainsi qu'au post-traitement des
+données.
+
+## Scripts
+
+### Animate
+`animate.py` permet d'obtenir une animation de `alpha.water` et `U` en sortie du modèle Olaflow.
+
+```python -m processing.animate -o OUTPUT [-v] [-m] [-i]```
+
+* `-o OUTPUT` : choix du dossier de sortie dans lequel travailler
+* `-v` : verbose
+* `-m` : au-lieu d'une animation, tracer le maximum de chaque grandeur dans le modèle
+* `-i` : au-lieu d'une animation, tracer la valeur initiale de chaque grandeur