Metadata-Version: 2.1
Name: mira-simpeg
Version: 0.21.2.1a1
Summary: Mira Geoscience fork of SimPEG: Simulation and Parameter Estimation in Geophysics
Author-email: SimPEG developers <rowanc1@gmail.com>, Dominique Fournier <dominiquef@mirageoscience.com>
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.
        
Project-URL: Homepage, http://simpeg.xyz/
Project-URL: Documentation, https://docs.simpeg.xyz/
Project-URL: Repository, http://github.com/MiraGeoscience/simpeg
Keywords: geophysics,inverse problem
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: discretize>=0.10.0
Requires-Dist: empymod>=2.0.0
Requires-Dist: geoana>=0.5.0
Requires-Dist: geoh5py<0.11,>=0.10.0-alpha.1
Requires-Dist: matplotlib
Requires-Dist: numpy>=1.20
Requires-Dist: pandas
Requires-Dist: pymatsolver<0.3.0,>=0.2
Requires-Dist: scikit-learn>=1.2
Requires-Dist: scipy>=1.8.0
Provides-Extra: dask
Requires-Dist: dask[distributed]; extra == "dask"
Requires-Dist: distributed; extra == "dask"
Requires-Dist: fsspec>=0.3.3; extra == "dask"
Requires-Dist: zarr; extra == "dask"
Provides-Extra: choclo
Requires-Dist: choclo; extra == "choclo"
Provides-Extra: reporting
Requires-Dist: scooby; extra == "reporting"
Provides-Extra: plotting
Requires-Dist: plotly; extra == "plotting"
Provides-Extra: all
Requires-Dist: simpeg[choclo,dask,plotting,reporting]; extra == "all"
Provides-Extra: style
Requires-Dist: black==24.3.0; extra == "style"
Requires-Dist: flake8==7.0.0; extra == "style"
Requires-Dist: flake8-bugbear==23.12.2; extra == "style"
Requires-Dist: flake8-builtins==2.2.0; extra == "style"
Requires-Dist: flake8-mutable==1.2.0; extra == "style"
Requires-Dist: flake8-rst-docstrings==0.3.0; extra == "style"
Requires-Dist: flake8-docstrings==1.7.0; extra == "style"
Requires-Dist: flake8-pyproject==1.2.3; extra == "style"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-gallery>=0.1.13; extra == "docs"
Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: pillow; extra == "docs"
Requires-Dist: sympy; extra == "docs"
Requires-Dist: memory_profiler; extra == "docs"
Requires-Dist: python-kaleido; extra == "docs"
Provides-Extra: tests
Requires-Dist: simpeg[all,docs]; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: dev
Requires-Dist: simpeg[all,docs,style,tests]; extra == "dev"

.. 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 <https://calendar.google.com/calendar/b/0?cid=ZHVhamYzMWlibThycWdkZXM5NTdoYXV2MnNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`_, `ICAL <https://calendar.google.com/calendar/ical/duajf31ibm8rqgdes957hauv2s%40group.calendar.google.com/public/basic.ics>`_) 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 <https://mattermost.softwareunderground.org/simpeg>`_.


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 <https://docs.simpeg.xyz/content/getting_started/contributing/index.html>`_
for more information on how to contribute.
