Commit 473b83ff authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files

Numpy is needed to parse setup.py with Jinja

parent 807e1161
......@@ -13,8 +13,8 @@ graph LR;
ParameterFile-->Exploration-->Integration-->Evaluation;
```
`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/)
`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](Example_Parfile.py)
in the [*examples* section].
......@@ -22,7 +22,7 @@ in the [*examples* section].
Once you have a parameter file, the recommended way to run `CORBASS` is to use
```console
(CORBASS)$ python run.py <path/to/parfile.py>
(CORBASS)$ python run.py <path/to/parfile.py>
```
This way the `CORBASS` posterior model coefficients, the NEZ- and DIF-field models
......@@ -30,7 +30,7 @@ and down component and intensity at the CMB are calculated and provided as `.txt
files. The output location is specified in the parameter file.
Under the hood, `CORBASS` first explores the model parameter space by using the
`exploration` module. This way the region of interest, i.e. where the
`exploration` module. This way the region of interest, i.e. where the
probability mass is concentrated, is found and can be accessed by the
`integration` module. The output can then be used to calculate further results,
using the `evaluation` module.
......@@ -41,29 +41,29 @@ each model in the [*examples* section].
[*examples* section]: (examples)
Cite as
> Schanner, M. and Mauerberger, S. (2019)
> CORBASS: CORrelation Based Archeomagnetic SnapShot model. V. 1.0.
> GFZ Data Services. http://doi.org/XXX
> Schanner, M. and Mauerberger, S. (2019)
> CORBASS: CORrelation Based Archeomagnetic SnapShot model. V. 1.0.
> GFZ Data Services. http://doi.org/XXX
TODO: #10
# Installation
0. Clone the repository
0. Clone the repository
```console
$ git clone https://gitext.gfz-potsdam.de/arthus/corbass.git
```
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/`.
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)
1. Install `conda-build` and `numpy` (to base)
```console
$ <conda>/bin/conda install conda-build
$ <conda>/bin/conda install conda-build numpy
```
2. Navigate to `<corbass>` and build [FieldTools]
......@@ -81,7 +81,7 @@ TODO: #10
$ source <conda>/bin/activate CORBASS
```
Careful with tcshell, you have to use activate.csh.
Careful with tcshell, you have to use activate.csh.
When you are done, deactivate the environment by
```console
(CORBASS)$ conda deactivate`.
......@@ -103,7 +103,7 @@ TODO: #10
# License
GNU General Public License, Version 3, 29 June 2007
Copyright (C) 2019 Maximilian Schanner, GFZ Potsdam
Copyright (C) 2019 Maximilian Schanner, GFZ Potsdam
Copyright (C) 2019 Stefan Mauerberger, University of Potsdam
CORBASS is free software: you can redistribute it and/or modify
......@@ -120,15 +120,15 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
# Contact
* [Maximilian Schanner](mailto:arthus@gfz-potsdam.de)
Helmholtz Centre Potsdam German Research Centre for Geoscienes GFZ
Section 2.3: Geomagnetism
Telegrafenberg
* [Maximilian Schanner](mailto:arthus@gfz-potsdam.de)
Helmholtz Centre Potsdam German Research Centre for Geoscienes GFZ
Section 2.3: Geomagnetism
Telegrafenberg
14473 Potsdam, Germany
* [Stefan Mauerberger](mailto:mauerber@uni-potsdam.de)
Institut of mathematics
University of Potsdam
Campus Golm, Haus 9
Karl-Liebknecht-Str. 24-25
14476 Potsdam OT Golm, Germany
\ No newline at end of file
* [Stefan Mauerberger](mailto:mauerber@uni-potsdam.de)
Institut of mathematics
University of Potsdam
Campus Golm, Haus 9
Karl-Liebknecht-Str. 24-25
14476 Potsdam OT Golm, Germany
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