README.md 8.34 KB
Newer Older
Maximilian Schanner's avatar
Maximilian Schanner committed
1
# pymagglobal
Maximilian Schanner's avatar
Maximilian Schanner committed
2

3
4
5
**python interface for global geomagnetic field models**

[[_TOC_]]
Maximilian Schanner's avatar
Maximilian Schanner committed
6

7
8
`pymagglobal` serves the purpose of replacing some Fortran scripts, which are used in the geomagnetism community to evaluate global field models. It can be applied to all cubic-spline based geomagnetic field models stored in the same file format as gufm1 or the CALSxk model series. However, care has to be taken that two header lines of the model files are formatted correctly and the list of spline knot point epochs starts only in line 3. The first header line has to contain start and end epoch of the model as the first two numbers, any further information in that line is ignored. The second header line has to start with three integers, which are the maximum spherical harmonic degree, a dummy that actually is not used, and the number of splines.  
By default, `pymagglobal` includes several models. Use
Maximilian Schanner's avatar
Maximilian Schanner committed
9
10
11
```console
$ pymagglobal --list-models
```
12
to get a list of these default models or go to [pymagglobal/dat](https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal/-/tree/master/pymagglobal/dat) for further information. Using
Maximilian Schanner's avatar
Maximilian Schanner committed
13
```console
14
$ pymagglobal ... <path/to/your_model>
Maximilian Schanner's avatar
Maximilian Schanner committed
15
```
16
you can use `pymagglobal` to evaluate your own models, if they come in a similar format. `<path/to/your_model>` specifies the path to your model and is given instead of the name of an included model. You can download additional models [here](ftp://ftp.gfz-potsdam.de/home/mag/arthus/pymagglobal_models/) and use them as above.
Maximilian Schanner's avatar
Maximilian Schanner committed
17

18
Once installed, `pymagglobal` can be imported and its routines used to access the models from inside your own python code.
Maximilian Schanner's avatar
Maximilian Schanner committed
19

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
## License
GNU General Public License, Version 3, 29 June 2007

Copyright (C) 2020 Helmholtz Centre Potsdam -  GFZ German Research Centre for Geosciences, Potsdam, Germany (https://www.gfz-potsdam.de)

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/>.

Data files are licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/).

40
## Citation
41
42
43
44
> Schanner, M. A.; Mauerberger, S.; Korte, M. (2020)  
> pymagglobal - Python interface for global geomagnetic field models. V. 0.1.0.  
> GFZ Data Services. https://doi.org/10.5880/GFZ.2.3.2020.005
[![DOI](https://img.shields.io/badge/DOI-10.5880%2FGFZ.2.3.2020.005-blue.svg)](http://doi.org/10.5880/GFZ.2.3.2020.005)
45

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
## Installation
> **Note:** pymagglobal depends on [cartopy](https://scitools.org.uk/cartopy). You have to install it, before running the install command.  
> This should also help if you receive `ImportError: NumPy 1.10+ is required to install cartopy.`

`pymagglobal` is distributed via the PyPI registry of this repository. It can be installed using
```console
$ pip install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
```

Since [conda](https://docs.conda.io/) version 4.6, conda and pip get along well. So you can also run `pip install ...` from inside your conda environment.

Another way to use `pymagglobal` is via nix-shell. With [nix](https://nixos.org/download.html) installed, simply run
```console
$ nix-shell
```
from within the `pymagglobal` root directory. You may also use the nix-expression [pymagglobal.nix] to include `pymagglobal` in your own environments.

63
## Documentation
64
Check out the extended documention [here](https://sec23.gitext-pages.gfz-potsdam.de/korte/pymagglobal). From the command line, you can use `pymagglobal` to get various results from the models. For example,
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
```console
$ pymagglobal dipole gufm1
```
will give a plot of the dipole moment time series for the model gufm1. In general, pymagglobal is called as
```console
$  pymagglobal command --options model
```
where `command` specifies the quantity you want to get from `pymagglobal` and `model` is the respective model. You can use 
```console
$ pymagglobal command --options <path/to/your_model>
```
to parse your own model, if it is in a format similar to gufm1. Use
```console
$ pymagglobal --help
```
to get further information. Each command has its own help, so you may also use
```console
$ pymagglobal dipole --help
```
to get information on the options for the dipole time series.

When using `python` you can import the pymagglobal package and access the models directly:
```python
import pymagglobal
```
90
91
92
93
We can first use `built_in_models`, to access a dictionary of available models:
```python
models = built_in_models()
```
94
95
Using the function `file2splines` you can get a spline object, representing the model. For example, to get a spline object for gufm1, use
```python
96
gufm1_splines = pymagglobal.file2splines(models['gufm1'])
97
98
99
100
101
102
103
104
105
106
107
108
109
110
```
This object can be evaluated to get the coefficients for a specific epoch
```python
gufm1_1600 = gufm1_splines(1600)
```
or passed to other routines in pymagglobal. For example, to get the dipole series from above use
```python
import numpy as np

times = np.linspace(1590, 1990, 201)
gufm1_dipoles = pymagglobal.dipole_series(times, gufm1_splines)
```
Additionally, pymagglobal provides a `Model` class, which is set up with a path and a name:
```python
111
gufm1 = pymagglobal.Model('gufm1', models['gufm1'])
112
113
114
115
116
117
118
119
120
```
The object now contains several quantities of interest, for example the minimal and maximal time for which the model is valid
```python
>>> gufm1.t_min
1590.0
>>> gufm1.t_max
1990.0
```

121
122
123
124
125
126
## Testing

To test your `pymagglobal` installation, run
```console
$ python tests/run_tests.py
```
127
128
129
130
from `<pymagglobal>`. Some tests require `FieldTools`, `packaging` and `orthopoly` and will be skipped, if the respective pacakges are not available. You can install `orthopoly` and `packaging` together with `pymagglobal`, by running
```console
$ pip install pymagglobal[tests] --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
```
131
132
133
134
135

We also provide the expression for a nix-shell with all dependencies installed. This will however not test your local installation, but your local repository. To perform the tests, run
```console
$ nix-shell .tests-shell.nix --run "python tests/run_tests.py"
```
136
137
138
139
140
141
142
143
144
145
146

[FieldTools]: http://doi.org/10.5880/fidgeo.2019.033

## 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
147
`pymagglobal` uses `numpy`, `scipy`, `matplotlib` and `cartopy`:
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

[\[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"

168
For testing `pymagglobal`, we use `pyfield`, `orthopoly` and [`packaging`](https://packaging.pypa.io/):
169

170
171
172
173
[\[pyfield\]](http://doi.org/10.5880/fidgeo.2019.033) Matuschek, H. and Mauerberger, S. (2019)  
FieldTools - A toolbox for manipulating vector fields on the sphere  
GFZ Data Services. 10.5880/fidgeo.2019.033

Maximilian Schanner's avatar
Maximilian Schanner committed
174
175
[\[orthopoly\]](https://wordsworthgroup.github.io/orthopoly/index.html) Mark Baum (2020)  
 wordsworthgroup/orthopoly v0.7 (Version v0.7)  
176
Zenodo. http://doi.org/10.5281/zenodo.3779456