3D geomagnetic fieldlines from pymagglobal
==========================================
.. toctree::
   :hidden:

   examples


.. image:: paraview_2.png
  :alt: vector fieldlines of the Earth's magnetic field

This extension to `pymagglobal <https://sec23.git-pages.gfz-potsdam.de/korte/pymagglobal>`_ provides python scripts to generate 3D vectors of the Earth's magnetic field. These can be used to generate images of the geomagnetic fieldlines like the one above. The extension is provided as several python scripts, available via the `git repository of the project <https://git.gfz-potsdam.de/sec23/korte/pymagglobal-3d-fieldlines>`_.  In the :ref:`examples section <examples-label>`  we provide two use cases, generating images with `Mayavi <https://docs.enthought.com/mayavi/mayavi>`_ and `ParaView <https://www.paraview.org/>`_.
If you have trouble using the scripts or really any question, do not hestitate to `contact us <mailto:arthus@gfz-potsdam.de>`_.

If you use this extension, please cite it the following way

.. admonition:: Citation

  | **Schanner**, M. A. (2022)  
  | pymagglobal extension for 3D-fieldlines
  | https://sec23.git-pages.gfz-potsdam.de/korte/pymagglobal-3d-fieldlines
  | original doi: |doi-shield|

Dependencies
------------
As this is an extension to pymagglobal, you have to have pymagglobal installed in order to use it. See the `pymagglobal installation guide <https://sec23.git-pages.gfz-potsdam.de/korte/pymagglobal/installation>`_ for additional information. This extension further depends on wand and tqdm:

.. code-block:: bash

  $ pip3 install wand tqdm

Depending on your use case, you also have to install Mayavi or ParaView and PyEVTK to use this extension. Please refer to the usage examples for additional information.

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

.. |doi-shield| image:: https://img.shields.io/badge/DOI-10.5880%2FGFZ.2.3.2020.005-blue.svg
		      :target: http://doi.org/10.5880/GFZ.2.3.2020.005