spinifex.magnetic
=================

.. py:module:: spinifex.magnetic

.. autoapi-nested-parse::

   Module for getting the Earth magnetic field



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/spinifex/magnetic/models/index


Attributes
----------

.. autoapisummary::

   spinifex.magnetic.magnetic_models


Classes
-------

.. autoapisummary::

   spinifex.magnetic.MagneticFieldFunction


Package Contents
----------------

.. py:class:: MagneticFieldFunction

   Bases: :py:obj:`Protocol`


   Magnetic field callable


   .. py:method:: __call__(ipp: spinifex.geometry.get_ipp.IPP) -> MagneticProfile


.. py:data:: magnetic_models