.. planetMagFields documentation master file, created by
   sphinx-quickstart on Mon Jan 22 08:32:05 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

###############
Prerequisites
###############

Most basic functionalities of `planetMagFields` require only `NumPy <https://numpy.org/>`_, `Matplotlib <https://matplotlib.org/>`_ and `SciPy <https://www.scipy.org/>`_. Other than that, the following external libraries are used for a few different functions:

- 2D plotting for map projections other than Hammer : `Cartopy <https://scitools.org.uk/cartopy/docs/latest/>`_ library (see more under :ref:`Projections <secproj>`)
- Potential extrapolation: `SHTns <https://bitbucket.org/nschaeff/shtns>`_ library
- Writing vts files for 3D visualisation: `PyEVTK <https://github.com/paulo-herrera/PyEVTK>`_ library


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

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`