| Name | invert4geom JSON |
| Version |
0.11.1
JSON |
| download |
| home_page | None |
| Summary | Constrained gravity inversion to recover the geometry of a density contrast. |
| upload_time | 2024-11-20 19:45:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright 2023 Matt Tankersley 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. |
| keywords |
inversion
gravity
geometry
density
moho
sediment
geophysics
geology
geoscience
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">Invert4geom</h1>
<h2 align="center">3D geometric gravity inversions
</h2>
<p align="center">
<a href="https://invert4geom.readthedocs.io"><strong>Documentation Link</strong></a>
</p>
<!-- SPHINX-START-proj-desc -->
**Invert4geom** is a Python library for performing 3D geometric gravity inversions, where the aim is to recover the geometry of a density contrast.
Typical use cases include modeling the topography of the Moho, the sediment-basement contact, or bathymetry.
These density contrasts are represented by a layer of vertical right-rectangular prisms.
Since we use vertical prisms, they don't take the curvature of the Earth into account.
For large-scale applications, such as continental studies, it would be better to use tesseroids instead of prisms.
See the [overview](overview.md) for further description of this package and what it can be used for.
<!-- SPHINX-END-proj-desc -->
<!-- SPHINX-START-badges -->
<p align="center">
<a href="https://mybinder.org/v2/gh/mdtanker/invert4geom/main">
<img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a>
</p>
<p align="center">
<a href=https://pypi.org/project/invert4geom/>
<img src="https://img.shields.io/pypi/v/invert4geom?style=flat-square"
alt="Latest version on PyPI"/></a>
<a href=https://github.com/conda-forge/invert4geom-feedstock>
<img src="https://img.shields.io/conda/vn/conda-forge/invert4geom.svg?style=flat-square"
alt="Latest version on conda-forge"/></a>
<a href="https://codecov.io/gh/mdtanker/invert4geom"><img src="https://img.shields.io/codecov/c/github/mdtanker/invert4geom/main.svg?style=flat-square" alt="Test coverage status"/></a>
</p>
<p align="center">
<a href="https://pypi.org/project/invert4geom/"><img src="https://img.shields.io/pypi/pyversions/invert4geom?style=flat-square" alt="Compatible Python versions."/></a>
<a href="https://zenodo.org/doi/10.5281/zenodo.11951924"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.12547952.svg?style=flat-square" alt="Zenodo DOI"/></a>
<a href='https://readthedocs.org/projects/invert4geom/'><img src='https://readthedocs.org/projects/invert4geom/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>
</p>
<!-- SPHINX-END-badges -->
## Disclaimer
<p align="center">
🚨 **Ready for daily use but still changing.** 🚨
</p>
This means that we are still adding a lot of new features and sometimes we make changes to the ones we already have while we try to improve the software based on users' experience, test new ideas, make better design decisions, etc.
Some of these changes could be **backwards incompatible**.
Keep that in mind before you update Invert4Geom to a new major version (i.e. from `v1.0.0` to `v2.0.0`) and always check the [Changelog](https://github.com/mdtanker/invert4geom/blob/main/CHANGELOG.md) for `BREAKING CHANGES` and how to update your code appropriately.
I welcome any feedback, ideas, or contributions!
Please contact us on the [GitHub discussions page](https://github.com/mdtanker/invert4geom/discussions) or submit an [issue on GitHub](https://github.com/mdtanker/invert4geom/issues) for problems or feature ideas.
<!-- SPHINX-START-long-desc -->
#### What _Invert4Geom_ is for:
- invert **gravity** data to recover the topography of a density contrast
- use with **gridded** gravity data
- discretization using _vertical right-rectangular prisms_
- performing regional-residual separation
- stochastic uncertainty analysis of inversion results
- basic visualization tools
#### What _Invert4Geom_ is **NOT** for:
- performing parameter-estimation inversions (i.e. recovering density values) -> see [SimPEG](https://simpeg.xyz/) or [pyGIMLi](https://www.pygimli.org/index.html)
- a point-and-click GUI -> see [Geosoft/Seequent Oasis Montaj](https://www.seequent.com/products-solutions/geosoft-oasis-montaj/) or [MiraGeoscience VPmg](https://www.mirageoscience.com/mining-industry-software/geoscience-analyst-pro-geophysics/)
- a ready-to-use inversion with minimal user input
- use with discrete (un-gridded) gravity data -> see [Harmonica](https://www.fatiando.org/harmonica/latest/index.html) for gridding your data
- for processing gravity data -> see [Harmonica](https://www.fatiando.org/harmonica/latest/index.html) for gravity processing tools
- for use with tesseroids, or non-regular grids (raise an issue request if you want this implemented!)
- publication-quality visualization -> see [PyGMT](https://www.pygmt.org/dev/index.html) for plotting tools
<!-- SPHINX-END-long-desc -->
## How to contribute
I welcome all forms of contribution! If you have any questions, comments or suggestions, please open a [discussion](https://github.com/mdtanker/invert4geom/discussions/new/choose) or [issue (feature request)](https://github.com/mdtanker/invert4geom/issues/new/choose)!
Also, please feel free to share how you're using Invert4Geom, I'd love to know.
Please, read our [Contributor Guide](https://invert4geom.readthedocs.io/en/latest/contributing.html) to learn how you can contribute to the project.
Raw data
{
"_id": null,
"home_page": null,
"name": "invert4geom",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "inversion, gravity, geometry, density, Moho, sediment, geophysics, geology, geoscience",
"author": null,
"author_email": "Matt Tankersley <matt.d.tankersley@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/16/ce43f68d3d5a34c44441bb715c621b3daadcb7e8549bf75de6c298416f01/invert4geom-0.11.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Invert4geom</h1>\n<h2 align=\"center\">3D geometric gravity inversions\n</h2>\n\n<p align=\"center\">\n<a href=\"https://invert4geom.readthedocs.io\"><strong>Documentation Link</strong></a>\n</p>\n\n<!-- SPHINX-START-proj-desc -->\n\n**Invert4geom** is a Python library for performing 3D geometric gravity inversions, where the aim is to recover the geometry of a density contrast.\n\nTypical use cases include modeling the topography of the Moho, the sediment-basement contact, or bathymetry.\nThese density contrasts are represented by a layer of vertical right-rectangular prisms.\nSince we use vertical prisms, they don't take the curvature of the Earth into account.\nFor large-scale applications, such as continental studies, it would be better to use tesseroids instead of prisms.\n\nSee the [overview](overview.md) for further description of this package and what it can be used for.\n\n<!-- SPHINX-END-proj-desc -->\n\n<!-- SPHINX-START-badges -->\n\n<p align=\"center\">\n<a href=\"https://mybinder.org/v2/gh/mdtanker/invert4geom/main\">\n <img src=\"https://mybinder.org/badge_logo.svg\" alt=\"Binder link\"></a>\n </p>\n\n<p align=\"center\">\n<a href=https://pypi.org/project/invert4geom/>\n<img src=\"https://img.shields.io/pypi/v/invert4geom?style=flat-square\"\nalt=\"Latest version on PyPI\"/></a>\n<a href=https://github.com/conda-forge/invert4geom-feedstock>\n<img src=\"https://img.shields.io/conda/vn/conda-forge/invert4geom.svg?style=flat-square\"\nalt=\"Latest version on conda-forge\"/></a>\n<a href=\"https://codecov.io/gh/mdtanker/invert4geom\"><img src=\"https://img.shields.io/codecov/c/github/mdtanker/invert4geom/main.svg?style=flat-square\" alt=\"Test coverage status\"/></a>\n</p>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/invert4geom/\"><img src=\"https://img.shields.io/pypi/pyversions/invert4geom?style=flat-square\" alt=\"Compatible Python versions.\"/></a>\n<a href=\"https://zenodo.org/doi/10.5281/zenodo.11951924\"><img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.12547952.svg?style=flat-square\" alt=\"Zenodo DOI\"/></a>\n<a href='https://readthedocs.org/projects/invert4geom/'><img src='https://readthedocs.org/projects/invert4geom/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>\n </p>\n\n<!-- SPHINX-END-badges -->\n\n\n\n## Disclaimer\n\n<p align=\"center\">\n\ud83d\udea8 **Ready for daily use but still changing.** \ud83d\udea8\n</p>\n\nThis means that we are still adding a lot of new features and sometimes we make changes to the ones we already have while we try to improve the software based on users' experience, test new ideas, make better design decisions, etc.\nSome of these changes could be **backwards incompatible**.\nKeep that in mind before you update Invert4Geom to a new major version (i.e. from `v1.0.0` to `v2.0.0`) and always check the [Changelog](https://github.com/mdtanker/invert4geom/blob/main/CHANGELOG.md) for `BREAKING CHANGES` and how to update your code appropriately.\n\nI welcome any feedback, ideas, or contributions!\nPlease contact us on the [GitHub discussions page](https://github.com/mdtanker/invert4geom/discussions) or submit an [issue on GitHub](https://github.com/mdtanker/invert4geom/issues) for problems or feature ideas.\n\n<!-- SPHINX-START-long-desc -->\n\n#### What _Invert4Geom_ is for:\n\n- invert **gravity** data to recover the topography of a density contrast\n- use with **gridded** gravity data\n- discretization using _vertical right-rectangular prisms_\n- performing regional-residual separation\n- stochastic uncertainty analysis of inversion results\n- basic visualization tools\n\n#### What _Invert4Geom_ is **NOT** for:\n\n- performing parameter-estimation inversions (i.e. recovering density values) -> see [SimPEG](https://simpeg.xyz/) or [pyGIMLi](https://www.pygimli.org/index.html)\n- a point-and-click GUI -> see [Geosoft/Seequent Oasis Montaj](https://www.seequent.com/products-solutions/geosoft-oasis-montaj/) or [MiraGeoscience VPmg](https://www.mirageoscience.com/mining-industry-software/geoscience-analyst-pro-geophysics/)\n- a ready-to-use inversion with minimal user input\n- use with discrete (un-gridded) gravity data -> see [Harmonica](https://www.fatiando.org/harmonica/latest/index.html) for gridding your data\n- for processing gravity data -> see [Harmonica](https://www.fatiando.org/harmonica/latest/index.html) for gravity processing tools\n- for use with tesseroids, or non-regular grids (raise an issue request if you want this implemented!)\n- publication-quality visualization -> see [PyGMT](https://www.pygmt.org/dev/index.html) for plotting tools\n\n<!-- SPHINX-END-long-desc -->\n\n## How to contribute\nI welcome all forms of contribution! If you have any questions, comments or suggestions, please open a [discussion](https://github.com/mdtanker/invert4geom/discussions/new/choose) or [issue (feature request)](https://github.com/mdtanker/invert4geom/issues/new/choose)!\n\nAlso, please feel free to share how you're using Invert4Geom, I'd love to know.\n\nPlease, read our [Contributor Guide](https://invert4geom.readthedocs.io/en/latest/contributing.html) to learn how you can contribute to the project.\n",
"bugtrack_url": null,
"license": "Copyright 2023 Matt Tankersley 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. ",
"summary": "Constrained gravity inversion to recover the geometry of a density contrast.",
"version": "0.11.1",
"project_urls": {
"Bug Tracker": "https://github.com/mdtanker/invert4geom/issues",
"Changelog": "https://invert4geom.readthedocs.io/en/latest/changelog.html",
"Discussions": "https://github.com/mdtanker/invert4geom/discussions",
"Documentation": "https://invert4geom.readthedocs.io/",
"Homepage": "https://github.com/mdtanker/invert4geom"
},
"split_keywords": [
"inversion",
" gravity",
" geometry",
" density",
" moho",
" sediment",
" geophysics",
" geology",
" geoscience"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c65ac23258aaa8b0691c6a45897fe9ef73d29ca1e73fdebea6db6217fb17613",
"md5": "b1dda9d55ef38a4cd127971e23e23e6d",
"sha256": "ce51c5a83d2a8f11e5704bbf578ae4014ccf431d1a02710e8bdf9a2d0fed936a"
},
"downloads": -1,
"filename": "invert4geom-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1dda9d55ef38a4cd127971e23e23e6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 91844,
"upload_time": "2024-11-20T19:45:32",
"upload_time_iso_8601": "2024-11-20T19:45:32.166215Z",
"url": "https://files.pythonhosted.org/packages/5c/65/ac23258aaa8b0691c6a45897fe9ef73d29ca1e73fdebea6db6217fb17613/invert4geom-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf16ce43f68d3d5a34c44441bb715c621b3daadcb7e8549bf75de6c298416f01",
"md5": "7b0767215a1500399a2c7d428bf705bd",
"sha256": "c41f8c1ac2a03ba406941d80551926443b76dc3d59f8d4eca02256ca1a28ef3c"
},
"downloads": -1,
"filename": "invert4geom-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "7b0767215a1500399a2c7d428bf705bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 102526,
"upload_time": "2024-11-20T19:45:33",
"upload_time_iso_8601": "2024-11-20T19:45:33.611533Z",
"url": "https://files.pythonhosted.org/packages/bf/16/ce43f68d3d5a34c44441bb715c621b3daadcb7e8549bf75de6c298416f01/invert4geom-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 19:45:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdtanker",
"github_project": "invert4geom",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "invert4geom"
}
