mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-28 07:18:44 +08:00
Lindsey Heagy
118 lines
3.0 KiB
ReStructuredText
118 lines
3.0 KiB
ReStructuredText
.. image:: https://raw.github.com/simpeg/simpeg/master/docs/images/simpeg-logo.png
|
||
:alt: SimPEG Logo
|
||
|
||
SimPEG Documentation
|
||
********************
|
||
|
||
.. image:: https://img.shields.io/pypi/v/SimPEG.svg
|
||
:target: https://crate.io/packages/SimPEG/
|
||
:alt: Latest PyPI version
|
||
|
||
.. image:: https://img.shields.io/pypi/dm/SimPEG.svg
|
||
:target: https://crate.io/packages/SimPEG/
|
||
:alt: Number of PyPI downloads
|
||
|
||
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
|
||
:target: https://github.com/simpeg/simpeg/blob/master/LICENSE
|
||
:alt: BSD 3 clause license.
|
||
|
||
.. image:: https://api.travis-ci.org/simpeg/simpeg.svg?branch=master
|
||
:target: https://travis-ci.org/simpeg/simpeg
|
||
:alt: Travis CI build status
|
||
|
||
.. image:: http://img.shields.io/badge/GITTER-JOIN_CHAT-brightgreen.svg?style=flat-square
|
||
:alt: gitter chat room at https://gitter.im/simpeg/simpeg
|
||
:target: https://gitter.im/simpeg/simpeg
|
||
|
||
.. image:: https://codecov.io/gh/simpeg/simpeg/branch/master/graph/badge.svg
|
||
:target: https://codecov.io/gh/simpeg/simpeg
|
||
|
||
.. image:: https://www.quantifiedcode.com/api/v1/project/933aa3decf444538aa432c8817169b6d/badge.svg
|
||
:target: https://www.quantifiedcode.com/app/project/933aa3decf444538aa432c8817169b6d
|
||
:alt: Code issues
|
||
|
||
.. image:: https://api.codacy.com/project/badge/Grade/4fc959a5294a418fa21fc7bc3b3aa078
|
||
:target: https://www.codacy.com/app/lindseyheagy/simpeg?utm_source=github.com&utm_medium=referral&utm_content=simpeg/simpeg&utm_campaign=Badge_Grade
|
||
:alt: codacy
|
||
|
||
|
||
Simulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical applications.
|
||
|
||
Our 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, optimization routine, and geophysical problem
|
||
* built with the inverse problem in mind
|
||
* provides a framework for geophysical and hydrogeologic problems
|
||
* supports 1D, 2D and 3D problems
|
||
* designed for large-scale inversions
|
||
|
||
|
||
About SimPEG
|
||
************
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
content/api_core/api_bigPicture
|
||
content/api_core/api_installing
|
||
|
||
Examples
|
||
********
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
content/api_core/api_Examples
|
||
|
||
Packages
|
||
********
|
||
|
||
.. toctree::
|
||
:maxdepth: 3
|
||
|
||
content/em/index
|
||
content/dc/index
|
||
content/ip/index
|
||
content/mt/index
|
||
content/flow/index
|
||
|
||
Finite Volume
|
||
*************
|
||
|
||
.. toctree::
|
||
:maxdepth: 3
|
||
|
||
content/api_core/api_FiniteVolume
|
||
|
||
Forward Problems
|
||
****************
|
||
|
||
.. toctree::
|
||
:maxdepth: 3
|
||
|
||
content/api_core/api_ForwardProblem
|
||
|
||
Inversion Components
|
||
********************
|
||
|
||
.. toctree::
|
||
:maxdepth: 3
|
||
|
||
content/api_core/api_InversionComponents
|
||
|
||
Utility Codes
|
||
*************
|
||
|
||
.. toctree::
|
||
:maxdepth: 3
|
||
|
||
content/api_core/api_Utilities
|
||
|
||
|
||
Project Index & Search
|
||
**********************
|
||
|
||
* :ref:`genindex`
|
||
* :ref:`modindex`
|
||
* :ref:`search`
|