mira-simpeg 0.15.1.dev5

Mira Geoscience fork of SimPEG: Simulation and Parameter Estimation in Geophysics

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

You are welcome to join our forum and engage with people who use and develop SimPEG at: http://simpeg.discourse.group/.

Weekly meetings are open to all. They are generally held on Wednesdays at 10:30am PDT. Please see the calendar (GCAL, ICAL) for information on the next meeting.

Overview Video

Working towards all the Geophysics, but Backwards - SciPy 2016

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:

@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}
}

Electromagnetics

If you are using the electromagnetics module of SimPEG, please cite:

Lindsey J. Heagy, Rowan Cockett, Seogi Kang, Gudni K. Rosenkjaer, Douglas W. Oldenburg, A framework for simulation and inversion in electromagnetics, Computers & Geosciences, Volume 107, 2017, Pages 1-19, ISSN 0098-3004, http://dx.doi.org/10.1016/j.cageo.2017.06.018.

BibTex:

@article{heagy2017,
    title= "A framework for simulation and inversion in electromagnetics",
    author= "Lindsey J. Heagy and Rowan Cockett and Seogi Kang and Gudni K. Rosenkjaer and Douglas W. Oldenburg",
    journal= "Computers & Geosciences",
    volume = "107",
    pages = "1 - 19",
    year = "2017",
    note = "",
    issn = "0098-3004",
    doi = "http://dx.doi.org/10.1016/j.cageo.2017.06.018"
}

Installing from the sources

This Python package can be installed with pip. The dependencies are defined in pyproject.toml. It replaces the former requirements.txt and setup.py files (see pip documentation to learn more about pyproject.toml).

As this branch is meant to be used with a geopps environment, some conflicting packages have been moved to “extras” and declared optional. To use it outside of geoapps, install it with simpeg[regular]. To benefit from dask, install it with simpeg[regular, dask].

Install from a local clone

pip install path/to/simpeg[regular,dask]

Install from a local clone in editable mode

pip install -e path/to/simpeg[regular,dask]

Links

Website: http://simpeg.xyz

Slack (real time chat): http://slack.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