Skip to content
Forward modeling, inversion, and processing gravity and magnetic data
Branch: master
Clone or download
leouieda Pin version of CI scripts to 1.0.0 (#50)
Don't clone from master to avoid breaking the builds when the scripts
update.
Latest commit cafab1b Mar 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
data
doc Assign authorship to "The Harmonica Developers" (#44) Feb 22, 2019
examples
harmonica
.appveyor.yml
.codacy.yml
.codeclimate.yml
.codecov.yml Add project structure and support files Jul 15, 2018
.coveragerc Ellipsoids for gravity and coordinate calculations (#5) Oct 18, 2018
.gitignore Add project structure and support files Jul 15, 2018
.pylintrc
.stickler.yml
.travis.yml Pin version of CI scripts to 1.0.0 (#50) Mar 20, 2019
AUTHORS.md
CODE_OF_CONDUCT.md Add project structure and support files Jul 15, 2018
CONTRIBUTING.md
LICENSE.txt
MAINTENANCE.md Remove "harmonica" mentions from maintenance guide Oct 24, 2018
MANIFEST.in
Makefile
README.rst Add project goals and description to the README Sep 14, 2018
environment.yml
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
versioneer.py Add project structure and support files Jul 15, 2018

README.rst

Harmonica

Documentation | Documentation (dev version) | Contact | Part of the Fatiando a Terra project

Latest version on PyPI TravisCI build status AppVeyor build status Test coverage status Code quality status Code quality grade on codacy Compatible Python versions. Chat room on Gitter

Disclaimer

🚨 This package is in early stages of design and implementation. 🚨

We welcome any feedback and ideas! Let us know by submitting issues on Github or send us a message on our Gitter chatroom.

About

Harmonica is a Python library for processing and modeling gravity and magnetic data. It includes common processing steps, like calculation of normal gravity, terrain correction, reduction to the pole, upward continuation, equivalent layers, and more. There are forward modeling functions for basic geometric shapes, like spheres, prisms, polygonal prisms, and tesseroids. The inversion methods are implemented as classes with an interface inspired by scikit-learn (like Verde).

Project goals

These are the long-term goals for Harmonica:

  • Efficient, well designed, and fully tested code for gravity and magnetic 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 new methods.

See the Github milestones for short-term goals.

Things that will not be covered in Harmonica:

  • Multi-physics partial differential equation solvers. Use SimPEG or PyGIMLi instead.
  • Generic grid processing methods (like horizontal derivatives and FFT). These should be implemented in Verde.
  • Data visualization.
  • GUI applications.

Contacting Us

Contributing

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing Guidelines

Please read our Contributing Guide to see how you can help and give feedback.

Imposter syndrome disclaimer

We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer?

We assure you that the little voice in your head is wrong.

Being a contributor doesn't just mean writing code. Equality important contributions include: writing or proof-reading documentation, suggesting or implementing tests, or even giving feedback about the project (including giving feedback about the contribution process). If you're coming to the project with fresh eyes, you might see the errors and assumptions that seasoned contributors have glossed over. If you can write any code at all, you can contribute code to open source. We are constantly trying out new skills, making mistakes, and learning from those mistakes. That's how we all improve and we are happy to help others learn.

This disclaimer was adapted from the MetPy project.

License

This is free software: you can redistribute it and/or modify it under the terms of the BSD 3-clause License. A copy of this license is provided in LICENSE.txt.

Documentation for other versions

You can’t perform that action at this time.