diff --git a/olaflow/README.md b/olaflow/README.md index 05423f3..a76ba46 100644 --- a/olaflow/README.md +++ b/olaflow/README.md @@ -50,5 +50,20 @@ out : dossier de sortie de la bathymétrie ```python -m processing.flow_velocity -o OUTPUT [-f FUNCTION]``` -* `-o OUTPUT` : dossier des sorties de Olaflow à utiliser (répéter pour les modèles à comparer) +* `-o OUTPUT` : dossier des sorties de Olaflow à utiliser * `-f FUNCTION` : fonction de post-traitement à comparer (`graphUniform` ou `graphUniform2`) + +### Olaflow + +`olaflow.py` définit la classe Python OFModel permettant de traiter les données de sortie de Olaflow. + +### Pickle + +`pickle.py` permet de lire les données de sortie d'un modèle Olaflow et de les convertir en objet `OFModel`, puis +d'enregistrer cet objet pour une utilisation efficace avec Python. + +```python -m processing.pickle -i INPUT -o OUTPUT [-z]``` + +* `-i INPUT` : dossier de sortie d'Olaflow +* `-o OUTPUT` : dossier de sortie à utiliser +* `-z` : activer la compression gzip (déconseillé)