Files
simpeg/docs/index.rst
T

100 lines
1.9 KiB
ReStructuredText

.. image:: simpeg-logo.png
:width: 300 px
:alt: SimPEG
:align: center
Simulation and Parameter Estimation in Geophysics
*************************************************
SimPEG 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: 3
api_Mesh
api_DiffOps
api_InnerProducts
Forward Problems
****************
.. toctree::
:maxdepth: 2
api_Problem
api_Survey
Inversion
*********
.. toctree::
:maxdepth: 3
api_DataMisfit
api_Inverse
Utility Codes
*************
.. toctree::
:maxdepth: 2
api_Solver
api_Maps
api_Utils
Miscellaneous
*************
.. toctree::
:maxdepth: 2
api_license
api_Tests
* Travis-CI Testing
.. image:: https://travis-ci.org/simpeg/simpeg.svg?branch=master
:target: https://travis-ci.org/simpeg/simpeg
:alt: Master Branch
:align: center
* Coveralls Testing
.. image:: https://coveralls.io/repos/simpeg/simpeg/badge.png?branch=master
:target: https://coveralls.io/r/simpeg/simpeg?branch=master
:alt: Coveralls
:align: center
Projects Using SimPEG
*********************
.. include:: ../PROJECTS.rst
Project Index & Search
**********************
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`