index.rst 2.31 KB
Newer Older
1
2
A python interface for global geomagnetic field models
======================================================
Maximilian Schanner's avatar
Maximilian Schanner committed
3
4
5
6
7
8
9
10
.. toctree::
   :hidden:

   package_documentation
   command_line_interface
   examples
   CHANGELOG

11

Maximilian Schanner's avatar
Maximilian Schanner committed
12
:code:`pymagglobal` serves the purpose of replacing some Fortran scripts, which are used in the geomagnetism community to evaluate global field models.
13
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.
14

Maximilian Schanner's avatar
Maximilian Schanner committed
15
:code:`pymagglobal` comes with a GUI, that can be started from the command line via
16

Maximilian Schanner's avatar
Maximilian Schanner committed
17
18
19
.. code-block:: bash

  $ pymagglobal-gui
20

21
22
23
24

Installation
------------
.. note::
Maximilian Schanner's avatar
Maximilian Schanner committed
25
:code:`pymagglobal` depends on :code:`cartopy <https://scitools.org.uk/cartopy>`_. You have to install it, before running the install command.   
26
27
28
  This should also help if you receive :code:`ImportError: NumPy 1.10+ is required to install cartopy.` 


29
:code:`pymagglobal` is distributed via the PyPI registry of the corresponding repository. It can be installed using  
30
31
32

.. code-block:: bash

33
  $ pip3 install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@git.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
34

35
See also `here <https://git.gfz-potsdam.de/sec23/korte/pymagglobal#installation>`_ and `here <https://git.gfz-potsdam.de/sec23/korte/pymagglobal#testing>`_.
36

37
.. include:: ../pymagglobal/dat/README.rst
38

39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
License
-------
GNU General Public License, Version 3, 29 June 2007

Copyright (C) 2020 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/>.
58
59
60
61
62
63
64

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
65
* `Repository <https://git.gfz-potsdam.de/sec23/korte/pymagglobal/>`_