simpeg

Simulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical applications.

https://github.com/simpeg/simpeg

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 9 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
3 of 44 committers (6.8%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary

Keywords

direct-current-resistivity electromagnetics finite-volume geophysics geoscience induced-polarization inverse-problems inversion linear-algebra magnetotellurics modeling modelling multiphysics open-science optimization partial-differential-equations python richards-equation scientific-computing simulation

Keywords from Contributors

vtk meshes earth-science fatiando-a-terra

Last synced: 4 months ago · JSON representation ·

Repository

Simulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical applications.

Basic Info

Host: GitHub
Owner: simpeg
License: mit
Language: Python
Default Branch: main
Homepage: http://simpeg.xyz
Size: 88.9 MB

Statistics

Stars: 577
Watchers: 51
Forks: 279
Open Issues: 199
Releases: 64

Topics

Created about 12 years ago · Last pushed 4 months ago

Metadata Files

Readme Contributing License Code of conduct Citation Authors

README.rst

.. image:: https://raw.github.com/simpeg/simpeg/main/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/conda/v/conda-forge/simpeg.svg
    :target: https://anaconda.org/conda-forge/simpeg
    :alt: Latest conda-forge version

.. image:: https://img.shields.io/github/license/simpeg/simpeg.svg
    :target: https://github.com/simpeg/simpeg/blob/main/LICENSE
    :alt: MIT license

.. image:: https://dev.azure.com/simpeg/simpeg/_apis/build/status/simpeg.simpeg?branchName=main
    :target: https://dev.azure.com/simpeg/simpeg/_build/latest?definitionId=2&branchName=main
    :alt: Azure pipeline

.. image:: https://codecov.io/gh/simpeg/simpeg/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/simpeg/simpeg
    :alt: Coverage status

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.596373.svg
   :target: https://doi.org/10.5281/zenodo.596373

.. image:: https://img.shields.io/discourse/users?server=http%3A%2F%2Fsimpeg.discourse.group%2F
    :target: https://simpeg.discourse.group/

.. image:: https://img.shields.io/badge/simpeg-purple?logo=mattermost&label=Mattermost
    :target: https://mattermost.softwareunderground.org/simpeg

.. image:: https://img.shields.io/badge/Youtube%20channel-GeoSci.xyz-FF0000.svg?logo=youtube
    :target: https://www.youtube.com/channel/UCBrC4M8_S4GXhyHht7FyQqw

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: https://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
==============

.. 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"
    }

Questions
=========

If you have a question regarding a specific use of SimPEG, the fastest way
to get a response is by posting on our Discourse discussion forum:
https://simpeg.discourse.group/. Alternatively, if you prefer real-time chat,
you can join our Mattermost Team at
https://mattermost.softwareunderground.org/simpeg.
Please do not create an issue to ask a question.


Meetings
========

SimPEG hosts weekly meetings for users to interact with each other,
for developers to discuss upcoming changes to the code base, and for
discussing topics related to geophysics in general.
Currently our meetings are held every Wednesday, alternating between
a mornings (10:30 am pacific time) and afternoons (3:00 pm pacific time)
on even numbered Wednesdays. Find more info on our
`Mattermost `_.


Links
=====

Website:
https://simpeg.xyz

Forums:
https://simpeg.discourse.group/


Mattermost (real time chat):
https://mattermost.softwareunderground.org/simpeg


Documentation:
https://docs.simpeg.xyz


Code:
https://github.com/simpeg/simpeg


Tests:
https://dev.azure.com/simpeg/simpeg/_build


Bugs & Issues:
https://github.com/simpeg/simpeg/issues

Contributing
============

We always welcome contributions towards SimPEG whether they are adding
new code, suggesting improvements to existing codes, identifying bugs,
providing examples, or anything that will improve SimPEG.
Please checkout the `contributing guide `_
for more information on how to contribute.

Owner

Name: SimPEG
Login: simpeg
Kind: organization
Email: info@simpeg.xyz

Website: http://simpeg.xyz
Repositories: 37
Profile: https://github.com/simpeg

A community and tools for open geophysics.

Citation (CITATION.rst)

Citing SimPEG
-------------

There is a `paper about SimPEG <http://dx.doi.org/10.1016/j.cageo.2015.09.015>`_, if you use this code, please help our scientific visibility by citing our work!


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

GitHub Events

Total

Create event: 65
Release event: 2
Issues event: 67
Watch event: 69
Delete event: 49
Issue comment event: 288
Push event: 374
Pull request review event: 195
Pull request review comment event: 296
Pull request event: 160
Fork event: 15

Last Year

Create event: 65
Release event: 2
Issues event: 67
Watch event: 69
Delete event: 49
Issue comment event: 288
Push event: 374
Pull request review event: 195
Pull request review comment event: 296
Pull request event: 160
Fork event: 15

Committers

Last synced: over 1 year ago

All Time

Total Commits: 7,450
Total Committers: 44
Avg Commits per committer: 169.318
Development Distribution Score (DDS): 0.782

Past Year

Commits: 164
Committers: 14
Avg Commits per committer: 11.714
Development Distribution Score (DDS): 0.409

Top Committers

Name	Email	Commits
Lindsey Heagy	l**y@g**m	1,625
Rowan Cockett	r**n@v**m	1,271
Joseph Capriotti	j**i@g**m	1,169
Seogi Kang	s**9@g**m	644
Dom Fournier	f**o@g**m	611
Thibaut Astic	t**c@g**m	571
Devin Cowan	d**n@g**m	476
Gudni Karl Rosenkjaer	g**n@g**m	283
Santiago Soler	s**r@g**m	274
John Kuttai	j**i@g**m	99
Xiaolong Wei	5****3	93
Dave Marchant	d**t@g**m	68
Michael Mitchell	m**4@g**m	67
Dieter Werthmüller	m**l@w**g	54
Nick Williams	n**s@k**m	33
Eldad Haber	e**9@g**m	15
Richard Scott	7****Z	15
Lars Ruthotto	l**o@e**a	10
I-Kang Ding	i**g@k**m	10
Neil Godber	n**r@g**m	9
Jacob Edman	j**n@k**m	7
Luz Angelica Caudillo Mata	l**z@g**m	6
Brendan Smithyman	s**n@g**m	4
Franklin Koch	f**n@3**m	4
Zheng-Kai Ye	s**0@g**m	4
John Weiss	j**0@g**m	3
Kalen Martens	k**s@s**m	3
Blue Tyson	b****n	3
Williams A. Lima	d**a@g**m	2
Matthew Plough	m**h@k**m	2
and 14 more...

Committer Domains (Top 20 + Academic)

koboldmetals.com: 4 ost.ch: 1 gim.rwth-aachen.de: 1 berkeley.edu: 1 quantifiedcode.com: 1 gns.cri.nz: 1 sjgeophysics.com: 1 3ptscience.com: 1 eos.ubc.ca: 1 werthmuller.org: 1 visiblegeology.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 167
Total pull requests: 470
Average time to close issues: 7 months
Average time to close pull requests: about 2 months
Total issue authors: 51
Total pull request authors: 31
Average comments per issue: 1.82
Average comments per pull request: 2.48
Merged pull requests: 337
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 47
Pull requests: 165
Average time to close issues: 20 days
Average time to close pull requests: 10 days
Issue authors: 24
Pull request authors: 10
Average comments per issue: 1.15
Average comments per pull request: 1.62
Merged pull requests: 99
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

santisoler (42)
lheagy (18)
jcapriot (13)
dccowan (9)
domfournier (9)
thibaut-kobold (8)
prisae (6)
sgkang (3)
williamjsdavis (3)
kashkoulimohammad (3)
ckohnke (3)
rowanc1 (3)
johnweis0480 (2)
AmziJeffs (2)
redhog (2)

Pull Request Authors

santisoler (352)
jcapriot (127)
domfournier (32)
lheagy (30)
prisae (24)
dccowan (19)
thibaut-kobold (17)
ghwilliams (12)
johnweis0480 (11)
williamjsdavis (6)
YingHuuu (4)
kehrl-kobold (2)
redhog (2)
xiaolongw1223 (2)
dependabot[bot] (2)

Top Labels

Issue Labels

bug (20) maintenance (12) enhancement (10) documentation (8) question (3) refactor (2) mapping (1) community (1) EM (1) framework-bug (1) Good First Issue (1)

Pull Request Labels

ready for review (18) enhancement (11) in progress (10) EM (9) documentation (6) bug (5) NSEM (4) parallel (3) maintenance (2) dependencies (2) help wanted (2) simulation (2) SP (1) mapping (1) community (1) regularization (1)

Packages

Total packages: 3
Total downloads:
- pypi 4,670 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 3
(may contain duplicates)
Total versions: 110
Total maintainers: 8

proxy.golang.org: github.com/simpeg/simpeg

Documentation: https://pkg.go.dev/github.com/simpeg/simpeg#section-documentation
License: mit
Latest release: v0.24.0
published 8 months ago

Versions: 32
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 4 months ago

pypi.org: simpeg

SimPEG: Simulation and Parameter Estimation in Geophysics

Homepage: https://simpeg.xyz
Documentation: https://docs.simpeg.xyz
License: The MIT License (MIT) Copyright (c) 2013-2024 SimPEG Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 0.24.0
published 8 months ago

Versions: 75
Dependent Packages: 1
Dependent Repositories: 3
Downloads: 4,539 Last month

Rankings

Dependent packages count: 4.8%

Average: 7.5%

Downloads: 8.7%

Dependent repos count: 8.9%

Maintainers (4)

lheagy rowanc1 jcapriot santisoler

Last synced: 4 months ago

pypi.org: simpeg-archive

Mira fork of SimPEG: Simulation and Parameter Estimation in Geophysics

Homepage: http://simpeg.xyz/
Documentation: https://docs.simpeg.xyz/
License: MIT
Latest release: 0.11.0.1
published about 1 year ago

Versions: 3
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 131 Last month

Rankings

Stargazers count: 2.9%

Forks count: 3.3%

Dependent packages count: 6.6%

Downloads: 10.3%

Average: 10.8%

Dependent repos count: 30.6%

Maintainers (4)

andrewg-mira fourndo sebhmg mirageoscience.ci

Last synced: 4 months ago

Dependencies

requirements_dask.txt pypi

dask *
fsspec >=0.3.3
zarr *

requirements_dev.txt pypi

black ==21.7b0 development
empymod * development
jupyter * development
memory_profiler * development
nbsphinx * development
numpy >=1.7 development
numpydoc * development
pillow * development
plotly * development
pre-commit * development
pydata-sphinx-theme * development
pylint * development
pytest * development
pytest-cov * development
scikit-learn >=0.22 development
scipy >=1.0.0 development
scooby * development
sphinx * development
sphinx-gallery >=0.1.13 development
sphinx-toolbox * development
sphinx_rtd_theme * development
sphinxcontrib-apidoc * development
sympy * development
toolz * development
twine * development
wheel * development

requirements_style.txt pypi

black ==21.7b0
click ==8.0.4
flake8 *
flake8-bugbear *
flake8-builtins *
flake8-docstrings *
flake8-mutable *
flake8-rst-docstrings *

setup.py pypi

discretize >=0.7.1
empymod *
geoana >=0.4.0
matplotlib *
numpy >=1.7
pandas *
pymatsolver >=0.1.1
scikit-learn >=0.22
scipy >=1.0.0

requirements.txt pypi