Commit f447fe2a authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Order & polish

parent 1d1b856e
# CORBASS
### 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
repository can be seen as supplementary material to this publication.
repository can be seen as supplementary material to this publication. Below this
section we give installation instructions.
From an algorithmic point of view, `CORBASS` can be simplified in the following
flowchart:
......@@ -64,16 +16,14 @@ graph LR;
`CORBASS` uses parameter files, which include among other things a link to
datasets, in a format similar to the [GEOMAGIA](http://geomagia.gfz-potsdam.de/)
output. Thus a first step is to create such a file for your data. You can find
an [example](examples/Example_Parfile.py)
in the [*examples* section](examples/).
Once you have a parameter file, the recommended use is to
`conda activate CORBASS`
an [example](Example_Parfile.py)
in the [*examples* section].
and then use
Once you have a parameter file, the recommended way to run `CORBASS` is to use
`python run.py <path/to/parfile.py>` .
```console
(CORBASS)$ python run.py <path/to/parfile.py>` .
```
This way the CORBASS posterior model coefficients, the NEZ- and DIF-field models
and down component and intensity at the CMB are calculated and provided as `.txt`
......@@ -86,7 +36,9 @@ probability mass is concentrated, is found and can be accessed by the
using the `evaluation` module.
If you want to use the individual models, you can find Jupyter notebooks for
each model in the *examples* section.
each model in the [*examples* section].
[*examples* section]: (examples)
Cite as
> Schanner, M. and Mauerberger, S. (2019)
......@@ -95,6 +47,55 @@ Cite as
TODO: #10
# Installation
In the following `<corbass>` refers to the path you cloned the `CORBASS` repository into.
1. Download and install [Miniconda](https://conda.io/miniconda.html) for Python 3.
By default, the installation directory `<conda>` is `~/miniconda3/`.
If you let conda modify your `bash.rc`, `<conda>/bin/conda` may be replaced by
`conda`.
2. Build and install [FieldTools]
1. Install `conda-build` (to base)
```console
$ <conda>/bin/conda install conda-build
```
2. Navigate to `<corbass>` and build [FieldTools]
```console
$ <conda>/bin/conda build FieldTools
```
3. Create the virtual environment `CORBASS`
```console
$ <conda>/bin/conda env create -f corbass.yml
```
4. Activate the virtual environment
```console
$ source <conda>/bin/activate CORBASS
```
Careful with tcshell, you have to use activate.csh.
In case you are done, deactivate the environment by
```console
(CORBASS)$ conda deactivate`.
```
5. Install optional packages, for example
```console
(CORBASS)$ conda install ipython jupyter notebook
```
6. If [corbass.yml](corbass.yml) changes, you are recommended to update your environment:
```console
$ <conda>/bin/conda env update -f corbass.yml
```
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
# License
GNU General Public License, Version 3, 29 June 2007
......
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