.. _api:

List of functions and classes (API)
===================================

.. automodule:: choclo

.. currentmodule:: choclo

Kernel and forward modelling functions
--------------------------------------

Here you will find the list of available kernel and forward modelling functions
for gravity and magnetic fields generated by different type of sources.

Point sources and dipoles
~~~~~~~~~~~~~~~~~~~~~~~~~

For point sources, dipoles and observation points defined in **Cartesian
coordinates**.

Gravity
^^^^^^^

.. autosummary::
   :toctree: generated/

    point.gravity_pot
    point.gravity_e
    point.gravity_n
    point.gravity_u
    point.gravity_ee
    point.gravity_nn
    point.gravity_uu
    point.gravity_en
    point.gravity_eu
    point.gravity_nu

Magnetic
^^^^^^^^

.. autosummary::
   :toctree: generated/

    dipole.magnetic_e
    dipole.magnetic_n
    dipole.magnetic_u
    dipole.magnetic_field

Kernels
^^^^^^^

.. autosummary::
   :toctree: generated/

    point.kernel_pot
    point.kernel_e
    point.kernel_n
    point.kernel_u
    point.kernel_ee
    point.kernel_nn
    point.kernel_uu
    point.kernel_en
    point.kernel_eu
    point.kernel_nu


Rectangular Prisms
~~~~~~~~~~~~~~~~~~

Gravity
^^^^^^^

.. autosummary::
   :toctree: generated/

    prism.gravity_pot
    prism.gravity_e
    prism.gravity_n
    prism.gravity_u
    prism.gravity_ee
    prism.gravity_nn
    prism.gravity_uu
    prism.gravity_en
    prism.gravity_eu
    prism.gravity_nu

Magnetic
^^^^^^^^

.. autosummary::
   :toctree: generated/

    prism.magnetic_field
    prism.magnetic_e
    prism.magnetic_n
    prism.magnetic_u

Kernels
^^^^^^^

.. autosummary::
   :toctree: generated/

    prism.kernel_pot
    prism.kernel_e
    prism.kernel_n
    prism.kernel_u
    prism.kernel_ee
    prism.kernel_nn
    prism.kernel_uu
    prism.kernel_en
    prism.kernel_eu
    prism.kernel_nu


Utilities
---------

Euclidean distances
~~~~~~~~~~~~~~~~~~~

Use these functions to compute Euclidean distance in Cartesian and spherical
coordinates:

.. autosummary::
   :toctree: generated/

    utils.distance_cartesian
    utils.distance_spherical
    utils.distance_spherical_core


Universal Constants
~~~~~~~~~~~~~~~~~~~

Access universal physical constants given in SI units:

.. autosummary::
   :toctree: generated/

    constants.GRAVITATIONAL_CONST
    constants.VACUUM_MAGNETIC_PERMEABILITY