Update README, orbitals

data/README.md

@@ -0,0 +1,38 @@
+# Data
+
+Ce dossier regroupe les données d'entrée et les scripts de pré-traitement des données.
+
+## Configuration initiale
+
+Afin de limiter l'espace utilisé, le fichier de bathymétrie n'est pas fourni. Il est recommandé d'utiliser la base de
+donnée construite par V. Roeber.
+
+Les scripts de ce dossier sont configurés à l'aide d'un fichier `config.ini`. Les options seront détaillées pour chaque
+script par la suite.
+
+## Scripts
+### Lambert
+`lambert.py` contient une classe permettant de réaliser la projection en coordonnées cartésiennes de la bathymétrie en
+coordonnées sphériques.
+
+### Nandasena
+`nandasena.py` permet de calculer le critère de déplacement de bloc de Nandasena (2011). Configuration dans le code
+directement en modifiant le contenu de la variable `const`.
+
+### Orbitals
+`orbitals.py` permet de tracer la trajectoire de la bouée lors du passage de la vague scélérate identifiée en 2 et 3
+dimensions.
+
+`python -m processing.orbitals [-c CONFIG] [-v]`
+
+* `-c CONFIG` : choix d'un fichier de configuration (`.ini`)
+* `-v` : verbose
+
+```
+[inp]
+root : racine des fichiers d'entrée
+raw_ts : liste des chemins vers les fichiers de données brutes de la bouée
+
+[out]
+root : racine des fichiers de sortie
+```