Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 4.97 KB

README.md

File metadata and controls

90 lines (65 loc) · 4.97 KB

Invert4geom

3D geometric gravity inversions

Documentation Link

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 for further description of this package and what it can be used for.

Binder link

Latest version on PyPI Latest version on conda-forge Test coverage status

Compatible Python versions. Zenodo DOI Documentation Status

Disclaimer

🚨 **Ready for daily use but still changing.** 🚨

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 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 or submit an issue on GitHub for problems or feature ideas.

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 or pyGIMLi
  • a point-and-click GUI -> see Geosoft/Seequent Oasis Montaj or MiraGeoscience VPmg
  • a ready-to-use inversion with minimal user input
  • use with discrete (un-gridded) gravity data -> see Harmonica for gridding your data
  • for processing gravity data -> see Harmonica 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 for plotting tools

How to contribute

I welcome all forms of contribution! If you have any questions, comments or suggestions, please open a discussion or issue (feature request)!

Also, please feel free to share how you're using Invert4Geom, I'd love to know.

Please, read our Contributor Guide to learn how you can contribute to the project.