.. _api:

=============
API Reference
=============

Geophysical Simulation Modules
==============================

.. toctree::
  :maxdepth: 2

  simpeg.potential_fields
  simpeg.electromagnetics
  simpeg.flow
  simpeg.seismic

SimPEG Building Blocks
======================

Base SimPEG
-----------
.. toctree::
  :maxdepth: 3

  simpeg

Regularizations
---------------
.. toctree::
  :maxdepth: 2

  simpeg.regularization

Directives
----------
.. toctree::
  :maxdepth: 2

  simpeg.directives

Utilities
---------

Classes and functions for performing useful operations.

.. toctree::
  :maxdepth: 2

  simpeg.utils

Meta
----
Classes for encapsulating many simulations.

.. toctree::
  :maxdepth: 2

  simpeg.meta


Typing
------

PEP 484 type aliases used in ``simpeg``.

.. toctree::
  :maxdepth: 1

  simpeg.typing