.. image:: simpeg-logo.png
   :width: 300 px
   :alt: SimPEG
   :align: center

SimPEG (Simulation and Parameter Estimation in Geophysics) is a python
package for simulation and gradient based parameter estimation in the
context of geoscience applications.

The vision is to create a package for finite volume simulation and parameter estimation with
applications to geophysical imaging and subsurface flow. To enable
these goals, this package has the following features:


   * is modular with respect to discretization, physics, optimization, and regularization
   * is built with the (large-scale) inverse problem in mind
   * provides a framework for geophysical and hydrogeologic problems
   * supports 1D, 2D and 3D problems


.. image:: simpeg-framework.png
   :width: 400 px
   :alt: Framework
   :align: center

Meshing & Operators
*******************

.. toctree::
   :maxdepth: 2

   api_Mesh

Forward Problems
****************

.. toctree::
   :maxdepth: 2

   api_Forward

Inversion
*********

.. toctree::
   :maxdepth: 2

   api_Inverse
   api_Parameters

Testing SimPEG
**************

.. toctree::
   :maxdepth: 2

   api_Tests

* Master Branch
   .. image:: https://travis-ci.org/simpeg/simpeg.png?branch*master
      :target: https://travis-ci.org/simpeg/simpeg
      :alt: Master Branch
      :align: center

* Develop Branch
   .. image:: https://travis-ci.org/simpeg/simpeg.png?branch*develop
      :target: https://travis-ci.org/simpeg/simpeg
      :alt: Develop Branch
      :align: center


Utility Codes
*************

.. toctree::
   :maxdepth: 2

   api_Utils


Project Index & Search
**********************

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