mirror of
https://github.com/wassname/simpeg.git
synced 2026-06-28 03:51:17 +08:00
Lindsey Heagy
91 lines
2.8 KiB
ReStructuredText
91 lines
2.8 KiB
ReStructuredText
.. image:: https://raw.github.com/simpeg/simpeg/master/docs/images/simpeg-logo.png
|
||
:alt: SimPEG Logo
|
||
|
||
======
|
||
SimPEG
|
||
======
|
||
|
||
.. 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:: https://img.shields.io/coveralls/simpeg/simpeg.svg
|
||
:target: https://coveralls.io/r/simpeg/simpeg?branch=master
|
||
:alt: Coverage 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
|
||
|
||
|
||
Simulation and Parameter Estimation in Geophysics - 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, 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
|
||
|
||
|
||
Citing SimPEG:
|
||
--------------
|
||
|
||
There is a paper about SimPEG!
|
||
|
||
|
||
Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W. (2015). SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications. Computers & Geosciences.
|
||
|
||
|
||
**BibTex:**
|
||
|
||
.. code::
|
||
|
||
@article{cockett2015simpeg,
|
||
title={SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications},
|
||
author={Cockett, Rowan and Kang, Seogi and Heagy, Lindsey J and Pidlisecky, Adam and Oldenburg, Douglas W},
|
||
journal={Computers \& Geosciences},
|
||
year={2015},
|
||
publisher={Elsevier}
|
||
}
|
||
|
||
|
||
Website:
|
||
http://simpeg.xyz
|
||
|
||
|
||
Documentation:
|
||
http://docs.simpeg.xyz
|
||
|
||
|
||
Code:
|
||
https://github.com/simpeg/simpeg
|
||
|
||
|
||
Tests:
|
||
https://travis-ci.org/simpeg/simpeg
|
||
|
||
|
||
Bugs & Issues:
|
||
https://github.com/simpeg/simpeg/issues
|
||
|
||
|
||
Code Snippets & Tutorials:
|
||
http://simpeg.xyz/Journal
|