Commit 33d02b3f authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Update README.md

parent bebc91cc
# Examples
As stated in the repository's [main readme file](https://gitext.gfz-potsdam.de/arthus/corbass/blob/master/README.md),
`CORBASS` uses parameter files to link to data and specify algorithm parameters.
To demonstrate the CORBASS workflow, we provide an [example parameter file](Example_Parfile.py).
To demonstrate the `CORBASS` workflow, we provide an [example parameter file](Example_Parfile.py).
The recommended way to evaluate this parameter file is to use
```console
(CORBASS)$ python run.py examples/Example_Parfile.py`.
......@@ -9,7 +9,7 @@ The recommended way to evaluate this parameter file is to use
Note that this may take a while. We also provide a [notebook](Example_4_Run.ipynb), illustrating this procedure.
Further, for each module there is a notebook to demonstrate what it does under the hood as
part of the CORBASS algorithm.
part of the `CORBASS` algorithm.
# Dependencies
If you wish to run the notebooks yourself, you need to install Jupyter and
......@@ -17,7 +17,7 @@ Jupyter notebook, via
```console
(CORBASS)$ conda install jupyter notebook
```
All notebooks should be run from inside the CORBASS environment, as indicated by
All notebooks should be run from inside the `CORBASS` environment, as indicated by
the `(CORBASS)` at the beginning of your console.
# References
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment