mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-27 19:48:52 +08:00
Lindsey Heagy
110 lines
2.5 KiB
ReStructuredText
110 lines
2.5 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://img.shields.io/travis/simpeg/simpeg.svg
|
|
:target: https://travis-ci.org/simpeg/simpeg?branch=master
|
|
:alt: Travis CI build status
|
|
|
|
.. image:: https://img.shields.io/coveralls/simpeg/simpeg.svg
|
|
:target: https://coveralls.io/r/simpeg/simpeg?branch=master
|
|
:alt: Coverage status
|
|
|
|
.. image:: https://codecov.io/gh/simpeg/simpeg/branch/master/graph/badge.svg
|
|
:target: https://codecov.io/gh/simpeg/simpeg
|
|
|
|
|
|
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`
|