Commit 6e573328 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Added ftp path + nix instructions

parent 11df6418
......@@ -4,9 +4,8 @@
[[_TOC_]]
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
`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
```console
$ pymagglobal --list-models
```
......@@ -14,9 +13,9 @@ to get a list of these default models or go to [pymagglobal/dat](https://gitext.
```console
$ pymagglobal ... <path/to/your_model>
```
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](TODO: PROVIDE MODELS VIA FTP) and use them as above.
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.
Once installed, pymagglobal can be imported and its routines used to access the models from inside your own python code.
Once installed, `pymagglobal` can be imported and its routines used to access the models from inside your own python code.
## License
GNU General Public License, Version 3, 29 June 2007
......@@ -40,7 +39,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
TODO
## Documentation
Check out the extended documention [here](http://arthus.gitext-pages.gfz-potsdam.de/pymagglobal). From the command line, you can use pymagglobal to get various results from the models. For example,
Check out the extended documention [here](http://arthus.gitext-pages.gfz-potsdam.de/pymagglobal). From the command line, you can use `pymagglobal` to get various results from the models. For example,
```console
$ pymagglobal dipole gufm1
```
......@@ -48,7 +47,7 @@ will give a plot of the dipole moment time series for the model gufm1. In genera
```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
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>
```
......@@ -94,7 +93,7 @@ The object now contains several quantities of interest, for example the minimal
```
## Installation
pymagglobal is built and installed using [conda](https://www.anaconda.com/).
`pymagglobal` is built and installed using [conda](https://www.anaconda.com/).
0. Clone the repository
```console
......@@ -153,6 +152,12 @@ which will do the next steps for you. If `install.sh` fails or you want to do th
$ pymagglobal --help
```
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.
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
## Contact
......@@ -163,7 +168,7 @@ Telegrafenberg
14473 Potsdam, Germany
## References
pymagglobal uses `numpy`, `scipy`, `matplotlib`, `cartopy` and `pyfield`:
`pymagglobal` uses `numpy`, `scipy`, `matplotlib`, `cartopy` and `pyfield`:
[\[scipy\]](https://www.scipy.org/) Pauli Virtanen, Ralf Gommers, Travis E. Oliphant, Matt Haberland,
Tyler Reddy, David Cournapeau, Evgeni Burovski, Pearu Peterson,
......
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