Commit 14b3423c authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files
parents 5fdfea4d a6ca26f6
......@@ -2,7 +2,52 @@
### CORrelation Based Archeomagnetic SnapShot model
# Installation
For the following `<corbass>` refers to the path you cloned the `CORBASS` repository into.
1. Download and install [Miniconda] for Python 3.
Typically, the installation directory `<conda>` is `~/miniconda3/`.
2. Build and install [FieldTools]
1. Install `conda-build` (not within a certain env but to base)
```console
$ <conda>/bin/conda install conda-build
```
2. Navigate to `<corbass>` and build [FieldTools]
```console
$ <conda>/bin/conda build FieldTools
```
3. To create the virtual environment `CORBASS` and its dependencies run
```console
$ <conda>/bin/conda env create -f corbass.yml
```
4. Activate virtual environment
```console
$ source <conda>/bin/activate CORBASS
```
Careful with tcshell. You have to use activate.csh.
In case you are don, deactivate the env by entering
```console
(CORBASS)$ conda deactivate`.
```
5. Install optional packages e.g.
```console
(CORBASS)$ conda install ipython jupyter
```
6. If the [corbass.yml](corbass.yml) changes, you are recommended to update your environment.
```console
$ <conda>/bin/conda env update ???
```
[Miniconda]: https://conda.io/miniconda.html
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
# Documentation
The `CORBASS` model is described in TODO: #12. In a way this
......
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