.. 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://pypi.python.org/pypi/SimPEG
:alt: Latest PyPI version
.. image:: https://img.shields.io/github/license/simpeg/simpeg.svg
:target: https://github.com/simpeg/simpeg/blob/master/LICENSE
:alt: MIT 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://codecov.io/gh/simpeg/simpeg/branch/master/graph/badge.svg
:target: https://codecov.io/gh/simpeg/simpeg
:alt: Coverage status
.. 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.
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 forum and engage with people who use and develop SimPEG at: https://groups.google.com/forum/#!forum/simpeg.
Overview Video
--------------
.. image:: https://img.youtube.com/vi/yUm01YsS9hQ/0.jpg
:target: https://www.youtube.com/watch?v=yUm01YsS9hQ
:alt: All of the Geophysics But Backwards
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:**
.. 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}
}
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:**
.. code::
@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]``.
.. _pip documentation: https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/
Install from a local clone
--------------------------
pip install path/to/simpeg[regular]
Install from a local clone in editable mode
-------------------------------------------
pip install -e path/to/simpeg[regular]
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
Raw data
{
"_id": null,
"home_page": "http://simpeg.xyz/",
"name": "simpeg-archive",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "geophysics inverse problem",
"author": "Rowan Cockett",
"author_email": "rowanc1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/87/74/f0347d954a9ecc325c63d2ab0f698e1353683da21f5f8989ca49b83013e2/simpeg_archive-0.11.0.dev6.tar.gz",
"platform": null,
"description": ".. image:: https://raw.github.com/simpeg/simpeg/master/docs/images/simpeg-logo.png\n :alt: SimPEG Logo\n\nSimPEG\n======\n\n.. image:: https://img.shields.io/pypi/v/SimPEG.svg\n :target: https://pypi.python.org/pypi/SimPEG\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/github/license/simpeg/simpeg.svg\n :target: https://github.com/simpeg/simpeg/blob/master/LICENSE\n :alt: MIT license\n\n.. image:: https://api.travis-ci.org/simpeg/simpeg.svg?branch=master\n :target: https://travis-ci.org/simpeg/simpeg\n :alt: Travis CI build status\n\n.. image:: https://codecov.io/gh/simpeg/simpeg/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/simpeg/simpeg\n :alt: Coverage status\n\n.. image:: https://api.codacy.com/project/badge/Grade/4fc959a5294a418fa21fc7bc3b3aa078\n :target: https://www.codacy.com/app/lindseyheagy/simpeg?utm_source=github.com&utm_medium=referral&utm_content=simpeg/simpeg&utm_campaign=Badge_Grade\n :alt: codacy\n\nSimulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical applications.\n\nThe 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:\n\n* modular with respect to the spacial discretization, optimization routine, and geophysical problem\n* built with the inverse problem in mind\n* provides a framework for geophysical and hydrogeologic problems\n* supports 1D, 2D and 3D problems\n* designed for large-scale inversions\n\nYou are welcome to join forum and engage with people who use and develop SimPEG at: https://groups.google.com/forum/#!forum/simpeg.\n\nOverview Video\n--------------\n\n.. image:: https://img.youtube.com/vi/yUm01YsS9hQ/0.jpg\n :target: https://www.youtube.com/watch?v=yUm01YsS9hQ\n :alt: All of the Geophysics But Backwards\n\nWorking towards all the Geophysics, but Backwards - SciPy 2016\n\nCiting SimPEG\n-------------\n\nThere is a paper about SimPEG!\n\n\n 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.\n\n**BibTex:**\n\n.. code::\n\n @article{cockett2015simpeg,\n title={SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications},\n author={Cockett, Rowan and Kang, Seogi and Heagy, Lindsey J and Pidlisecky, Adam and Oldenburg, Douglas W},\n journal={Computers \\& Geosciences},\n year={2015},\n publisher={Elsevier}\n }\n\nElectromagnetics\n****************\n\nIf you are using the electromagnetics module of SimPEG, please cite:\n\n 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.\n\n**BibTex:**\n\n.. code::\n\n @article{heagy2017,\n title= \"A framework for simulation and inversion in electromagnetics\",\n author= \"Lindsey J. Heagy and Rowan Cockett and Seogi Kang and Gudni K. Rosenkjaer and Douglas W. Oldenburg\",\n journal= \"Computers & Geosciences\",\n volume = \"107\",\n pages = \"1 - 19\",\n year = \"2017\",\n note = \"\",\n issn = \"0098-3004\",\n doi = \"http://dx.doi.org/10.1016/j.cageo.2017.06.018\"\n }\n\n\nInstalling from the sources\n===========================\n\nThis Python package can be installed with ``pip``.\nThe dependencies are defined in ``pyproject.toml``. It replaces the former ``requirements.txt`` and ``setup.py`` files\n(see `pip documentation`_ to learn more about ``pyproject.toml``).\n\nAs this branch is meant to be used with a geopps environment, some conflicting packages have been moved\nto \"extras\" and declared optional. To use it outside of ``geoapps``, install it with ``simpeg[regular]``.\n\n.. _pip documentation: https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/\n\nInstall from a local clone\n--------------------------\npip install path/to/simpeg[regular]\n\nInstall from a local clone in editable mode\n-------------------------------------------\npip install -e path/to/simpeg[regular]\n\n\nLinks\n-----\n\nWebsite:\nhttp://simpeg.xyz\n\n\nSlack (real time chat):\nhttp://slack.simpeg.xyz\n\n\nDocumentation:\nhttp://docs.simpeg.xyz\n\n\nCode:\nhttps://github.com/simpeg/simpeg\n\n\nTests:\nhttps://travis-ci.org/simpeg/simpeg\n\n\nBugs & Issues:\nhttps://github.com/simpeg/simpeg/issues\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mira fork of SimPEG: Simulation and Parameter Estimation in Geophysics",
"version": "0.11.0.dev6",
"project_urls": {
"Documentation": "https://docs.simpeg.xyz/",
"Homepage": "http://simpeg.xyz/",
"Repository": "http://github.com/simpeg/simpeg"
},
"split_keywords": [
"geophysics",
"inverse",
"problem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cebf835bfe4f5b90a9484b5ab434d6b0295bc9c8cc44d4c30c8a70cad61855a3",
"md5": "03efd6fd8c4498cc54949c56c3059bb7",
"sha256": "ddb2487b640846a6859afb6f9f33ec5a04e4e0d5572c690d4c1a88579a47adcb"
},
"downloads": -1,
"filename": "simpeg_archive-0.11.0.dev6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "03efd6fd8c4498cc54949c56c3059bb7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 199136,
"upload_time": "2023-08-23T20:50:22",
"upload_time_iso_8601": "2023-08-23T20:50:22.318529Z",
"url": "https://files.pythonhosted.org/packages/ce/bf/835bfe4f5b90a9484b5ab434d6b0295bc9c8cc44d4c30c8a70cad61855a3/simpeg_archive-0.11.0.dev6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8774f0347d954a9ecc325c63d2ab0f698e1353683da21f5f8989ca49b83013e2",
"md5": "99c7a94c056ebe56cb80d5caeaca9a4a",
"sha256": "37f30201cde1312a89d837db36f57a9a05795ea22136a16ec63c3c150dfd60f5"
},
"downloads": -1,
"filename": "simpeg_archive-0.11.0.dev6.tar.gz",
"has_sig": false,
"md5_digest": "99c7a94c056ebe56cb80d5caeaca9a4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 184327,
"upload_time": "2023-08-23T20:50:24",
"upload_time_iso_8601": "2023-08-23T20:50:24.314520Z",
"url": "https://files.pythonhosted.org/packages/87/74/f0347d954a9ecc325c63d2ab0f698e1353683da21f5f8989ca49b83013e2/simpeg_archive-0.11.0.dev6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-23 20:50:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simpeg",
"github_project": "simpeg",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "simpeg-archive"
}
JSON
