Files
simpeg/docs/index.rst
T
2014-04-06 21:50:11 -06:00

87 lines
1.6 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: 2
api_Mesh
api_DiffOps
api_InnerProducts
Forward Problems
****************
.. toctree::
:maxdepth: 2
api_Model
api_Survey
api_Problem
Inversion
*********
.. toctree::
:maxdepth: 2
api_Inverse
api_Parameters
Utility Codes
*************
.. toctree::
:maxdepth: 2
api_Solver
api_Utils
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
Project Index & Search
**********************
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`