Files
simpeg/docs/index.rst
T
2013-10-18 17:43:11 -07:00

75 lines
1.4 KiB
ReStructuredText

.. SimPEG documentation master file, created by
sphinx-quickstart on Fri Aug 30 18:42:44 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SimPEG
======
SimPEG (Simulation and Parameter Estimation in Geophysics) is a python package for simulation and gradient based parameter estimation in the context of geophysical applications.
The vision is to create a package for finite volume simulation with applications to geophysical imaging and subsurface flow. To enable the understanding of the many different components, this package has the following features:
* modular with respect to the spacial discretization
* is built with the inverse problem in mind
* supports different hyperbolic solvers (Euler, Semi-Lagrangian, Lagrangian)
* supports 2D and 3D problems
Meshing & Operators
===================
.. toctree::
:maxdepth: 2
api_BaseMesh
api_TensorMesh
api_TensorView
api_LogicallyOrthogonalMesh
api_Cyl1DMesh
api_LOMView
api_DiffOperators
api_InnerProducts
Forward Problems
================
.. toctree::
:maxdepth: 2
api_Problem
Inversion
=========
.. toctree::
:maxdepth: 2
api_Optimize
Testing SimPEG
==============
.. toctree::
:maxdepth: 2
api_Tests
Utility Codes
=============
.. toctree::
:maxdepth: 2
api_Utils
Project Index & Search
======================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`