Repository files navigation

Documentation (latest) •Documentation (main branch) •Contributing •Contact

Part of theFatiando a Terra project

Harmonica is a Python library for processing and modeling gravity andmagnetic data. It includes common processing steps, like calculation of Bouguerand terrain corrections, reduction to the pole, upward continuation, equivalentsources, and more. There are forward modeling functions for basic geometricshapes, like point sources, prisms and tesseroids. The inversion methods areimplemented as classes with an interface inspired by scikit-learn (likeVerde).

These are the long-term goals for Harmonica:

• Efficient, well designed, and fully tested code for gravity andmagnetic data.
• Cover the entire data life-cycle: from raw data to 3D Earth model.
• Focus on best-practices to discourage misuse of methods,particularly inversion.
• Easily extended code to enable research on the development of newmethods.

See theGitHub milestonesfor short-term goals.

Things that willnot be covered in Harmonica:

• Multi-physics partial differential equation solvers. UseSimPEG orPyGIMLiinstead.
• Generic grid processing methods (like FFT and standards interpolation).We'll rely onVerde,xrft andxarray for those.
• Data visualization.
• GUI applications.

🚨Harmonica is in early stages of design and implementation. 🚨

We welcome any feedback and ideas! Let us know by submittingissues on GitHub orjoining our community.

🗨️Contact us:Find out more about how to reach us atfatiando.org/contact.

👩🏾‍💻Contributing to project development:Please read ourContributing Guideto see how you can help and give feedback.

🧑🏾‍🤝‍🧑🏼Code of conduct:This project is released with aCode of Conduct.By participating in this project you agree to abide by its terms.

Imposter syndrome disclaimer:We want your help.No, really. There may be a little voice inside yourhead that is telling you that you're not ready, that you aren't skilledenough to contribute. We assure you that the little voice in your head iswrong. Most importantly,there are many valuable ways to contribute besideswriting code.

This disclaimer was adapted from theMetPy project.

This is free software: you can redistribute it and/or modify it under the termsof theBSD 3-clause License. A copy of this license is provided inLICENSE.txt.