From 7fd23959140f0845c36dbf2e0bb91aa12a03c88c Mon Sep 17 00:00:00 2001
From: "Edgar P. Burkhart" <git@edgarpierre.fr>
Date: Wed, 6 Jul 2022 09:15:31 +0200
Subject: [PATCH] Update README, diff

---
 olaflow/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/olaflow/README.md b/olaflow/README.md
index 594d81c..eca0cd8 100644
--- a/olaflow/README.md
+++ b/olaflow/README.md
@@ -32,3 +32,14 @@ scale* : échelle de la bathymétrie en [x,y,z]
 translate* : translation de la bathymétrie en [x,y,z]
 out : dossier de sortie de la bathymétrie
 ```
+
+### Diff
+
+`diff.py` permet de comparer les sorties de plusieurs modèles Olaflow.
+
+```python -m processing.diff -o OUTPUT ... [-t TIMESTEP] [-f FUNCTION] [-y FIELD]```
+
+* `-o OUTPUT` : dossier des sorties de Olaflow à utiliser (répéter pour les modèles à comparer)
+* `-t TIMESTEP` : instant auquel comparer les modèles
+* `-f FUNCTION` : fonction de post-traitement à comparer (`graphUniform` ou `graphUniform2`)
+* `-y FIELD` : champs à comparer (`alpha.water` ou `U`)