diff --git a/README.md b/README.md index 38c524d..e299b6c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,21 @@ displacement at the Artha breakwater on February 28, 2017" [Report](https://kalliope.edgarpierre.fr/latex/m2cce/internship/report.pdf) +## Configuration + +Each part can be run in their respective directories. +``` +$ python -m processing.swash -h +usage: swash.py [-h] [-v] [-c CONFIG] + +Run swash model + +options: + -h, --help show this help message and exit + -v, --verbose + -c CONFIG, --config CONFIG +``` + ## Bathymetry * Insert database in `data/data`