Metadata-Version: 2.1
Name: geoana
Version: 0.8.1
Summary: Analytic expressions for geophysical responses
Keywords: geophysics,electromagnetics,gravity,magnetics
Author-Email: SimPEG developers <lindseyheagy@gmail.com>
License: MIT License
         
         Copyright (c) 2017 SimPEG Team
         
         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.
         
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Cython
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
Project-URL: Homepage, https://simpeg.xyz
Project-URL: Documentation, https://geoana.simpeg.xyz
Project-URL: Repository, https://github.com/simpeg/geoana.git
Requires-Python: >=3.11
Requires-Dist: numpy>=1.22.4
Requires-Dist: scipy>=1.12
Requires-Dist: libdlf
Provides-Extra: plot
Requires-Dist: matplotlib; extra == "plot"
Provides-Extra: extras
Requires-Dist: utm; extra == "extras"
Provides-Extra: jittable
Requires-Dist: numba; extra == "jittable"
Provides-Extra: all
Requires-Dist: geoana[extras,jittable,plot]; extra == "all"
Provides-Extra: doc
Requires-Dist: sphinx==8.1.3; extra == "doc"
Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "doc"
Requires-Dist: sphinx-gallery==0.19.0; extra == "doc"
Requires-Dist: numpydoc==1.9.0; extra == "doc"
Requires-Dist: jupyter; extra == "doc"
Requires-Dist: graphviz; extra == "doc"
Requires-Dist: pillow; extra == "doc"
Requires-Dist: geoana[all]; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: sympy; extra == "test"
Requires-Dist: discretize; extra == "test"
Requires-Dist: requests; extra == "test"
Requires-Dist: geoana[all,doc]; extra == "test"
Provides-Extra: build
Requires-Dist: meson-python>=0.15.0; extra == "build"
Requires-Dist: meson; extra == "build"
Requires-Dist: ninja; extra == "build"
Requires-Dist: numpy>=2.0.0rc1; extra == "build"
Requires-Dist: cython>=3.1.0; extra == "build"
Requires-Dist: setuptools_scm; extra == "build"
Description-Content-Type: text/x-rst

| `getting_started`_ | `connecting`_ | `installing`_ | `license`_ | `documentation <https://geoana.simpeg.xyz/>`_ |

geoana
======

.. image:: https://img.shields.io/pypi/v/geoana.svg
    :target: https://pypi.python.org/pypi/geoana
    :alt: Latest PyPI version

.. image:: https://anaconda.org/conda-forge/geoana/badges/version.svg
    :target: https://anaconda.org/conda-forge/geoana
    :alt: Latest conda-forge version

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

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


`geoana` is a collection of (mostly) analytic functions in geophysics. We take an object oriented
approach with the aim of having users be able to readily interact with the functions using `Jupyter <https://jupyter.org>`_


.. _getting_started:

Getting started
---------------

- If you do not already have python installed, we recommend downloading and installing it through `anaconda <https://www.anaconda.com/download/>`_
- `installing`_ `geoana`
- Browse the `gallery <https://geoana.simpeg.xyz/auto_examples/>`_ for ideas and example usage
- Read the `documentation <https://geoana.simpeg.xyz/>`_ for more information on the library and what it can do

.. - See the `contributor guide` and `code of conduct` if you are interested in helping develop or maintain geoana

.. _connecting:

Connecting with the community
-----------------------------

geoana is a part of the larger `SimPEG <https://simpeg.xyz>`_ ecosystem. There are several avenues for connecting:

- a discourse website for questions: https://simpeg.discourse.group/
- a youtube channel where meeting recordings are posted: `GeoSci.xyz <https://www.youtube.com/channel/UCBrC4M8_S4GXhyHht7FyQqw>`_
- a slack group for real-time chat with users and developers of SimPEG: http://slack.simpeg.xyz/

.. _installing:

Installing
----------

**geoana** is on conda-forge

.. code:: shell

    conda install -c conda-forge geoana

**geoana** is available on `pypi <https://pypi.org/project/geoana/>`_ and can be installed by opening a command window and running:

.. code::

    pip install geoana


To install from source, you can

.. code::

    git clone https://github.com/simpeg/geoana.git
    pip install .

.. _license:

License
-------

geoana is licensed under the `MIT license <https://github.com/simpeg/geoana/blob/master/LICENSE>`_ .
