Commit 007e34d2 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Install instructions.

parent 7db4e4cc
# pyMagGlobal
# pymagglobal
python interface for global geomagnetic field models
\ No newline at end of file
### python interface for global geomagnetic field models
# License
GNU General Public License, Version 3, 29 June 2007
Copyright (C) 2019 Helmholtz Centre Potsdam GFZ, German Research Centre for Geosciences, Potsdam, Germany
pymagglobal is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
pymagglobal is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
# Citation
TODO
# Documentation
Use
```console
$ pymagglobal --help
```
to get info on how to use pymagglobal. TODO: Expand this section
# Installation
pymagglobal is built and installed using [conda](https://www.anaconda.com/).
0. Clone the repository
```console
$ git clone https://gitext.gfz-potsdam.de/arthus/pymagglobal.git
```
In the following `<pymagglobal>` refers to the path you cloned the `pymagglobal` 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`.
You may want to create a fresh environment for pymagmodesl. This is done using
```console
$ <conda>/bin/conda create --name Your_Environment
```
followed by
```console
$ <conda>/bin/conda activate Your_Environment
```
Careful: With tcshell, you have to use activate.csh.
2. Install `conda-build`
```console
$ <conda>/bin/conda install conda-build
```
3. Build [FieldTools]
This step will make the pyfield library available via the local conda channel.
Navigate to `<pymagglobal>` and build [FieldTools]
```console
$ <conda>/bin/conda build FieldTools
```
4. Build pymagglobal
Navigate to `../<pymagglobal>` and build pymagglobal
```console
$ <conda>/bin/conda build pymagglobal
```
5. Install pymagglobal
```console
$ <conda>/bin/conda install pymagglobal -c local
```
This will make `pymagglobal` available as a python package, i.e. you can use
```python
import pymagglobal
```
as well as register a shell command in your local environmet, so that you can run
```console
$ pymagglobal --help
```
With `conda-build` installed, you may also go to `<pymagglobal>` and run
```console
$ bash install.sh
```
which will simply do steps 3-5 for you.
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
# Contact
* [Maximilian Schanner](mailto:arthus@gfz-potsdam.de)
Helmholtz Centre Potsdam German Research Centre for Geoscienes GFZ
Section 2.3: Geomagnetism
Telegrafenberg
14473 Potsdam, Germany
# References
pymagglobal uses `numpy`, `scipy`, `matplotlib` and `cartopy`:
[\[scipy\]](https://www.scipy.org/) Pauli Virtanen, Ralf Gommers, Travis E. Oliphant, Matt Haberland,
Tyler Reddy, David Cournapeau, Evgeni Burovski, Pearu Peterson,
Warren Weckesser, Jonathan Bright, Stéfan J. van der Walt, Matthew Brett,
Joshua Wilson, K. Jarrod Millman, Nikolay Mayorov, Andrew R. J. Nelson,
Eric Jones, Robert Kern, Eric Larson, CJ Carey, İlhan Polat, Yu Feng,
Eric W. Moore, Jake VanderPlas, Denis Laxalde, Josef Perktold, Robert Cimrman,
Ian Henriksen, E.A. Quintero, Charles R Harris, Anne M. Archibald,
Antônio H. Ribeiro, Fabian Pedregosa, Paul van Mulbregt,
and SciPy 1.0 Contributors (2020)
"SciPy 1.0: Fundamental Algorithms for Scientific Computing in Python".
Nature Methods, in press.
[\[matplotlib\]](https://matplotlib.org/) J. D. Hunter (2007)
"Matplotlib: A 2D Graphics Environment",
Computing in Science & Engineering, vol. 9, no. 3, pp. 90-95
[\[cartopy\]](https://scitools.org.uk/cartopy) Met Office (2015)
"Cartopy: a cartographic python library with a Matplotlib interface"
\ No newline at end of file
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