mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-28 03:03:17 +08:00
Rowan Cockett
e622dfb5cc
Conflicts: .coveragerc .gitignore .travis.yml docs/api_Utils.rst docs/conf.py docs/index.rst requirements.txt setup.py
121 lines
2.0 KiB
ReStructuredText
121 lines
2.0 KiB
ReStructuredText
SimPEG Documentation
|
|
********************
|
|
|
|
.. image:: simpeg-logo.png
|
|
:width: 300 px
|
|
:alt: SimPEG
|
|
:align: center
|
|
|
|
SimPEG: Simulation and Parameter Estimation in Geophysics
|
|
|
|
SimPEG is a framework and a collection of tools that aid in the development of
|
|
large-scale geophysical inversion codes.
|
|
The vision is to create a modular and extensible 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 ... everything!
|
|
- is built with the (large-scale) inverse problem in mind
|
|
- provides a framework for geophysical and hydrogeologic problems
|
|
- supports 1D, 2D and 3D problems
|
|
- provides a set of commonly used visualization utilities
|
|
|
|
|
|
About SimPEG
|
|
************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api_bigPicture
|
|
api_license
|
|
|
|
|
|
Getting Started with SimPEG
|
|
***************************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api_installing
|
|
|
|
Discretization
|
|
**************
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
api_Mesh
|
|
api_DiffOps
|
|
api_InnerProducts
|
|
|
|
Forward Problems
|
|
****************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api_ForwardProblem
|
|
|
|
Inversion
|
|
*********
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
api_DataMisfit
|
|
api_Inverse
|
|
|
|
Utility Codes
|
|
*************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api_Solver
|
|
api_Maps
|
|
api_Utils
|
|
api_Tests
|
|
|
|
|
|
Packages
|
|
********
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
em/index
|
|
flow/index
|
|
|
|
Developer's Documentation
|
|
*************************
|
|
|
|
* 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
|
|
|
|
|
|
Project Index & Search
|
|
**********************
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
Examples
|
|
********
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api_Examples
|