Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 4.23 KB

README.md

File metadata and controls

90 lines (72 loc) · 4.23 KB
Raw

Choclo

Kernel functions for your geophysical models

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

Part of the Fatiando a Terra project, built in collaboration with SimPEG

Latest version on PyPI Latest version on conda-forge Test coverage status Compatible Python versions. DOI used to cite Choclo

About

Choclo is a Python library that hosts optimized kernel functions for running geophysical forward and inverse models, intended to be used by other libraries as the underlying layer of their computation. "Choclo" is a term used in some countries of South America to refer to corn, originated from the quechua word chuqllu.

Project goals

  • Provide optimized kernel functions for gravity and magnetic forward and inverse models that can be easily harnessed by different geophysical libraries.
  • Generate a pure-Python library that could be easily distributed and installed on any operating system.
  • Rely on Numba for just-in-time compilations and optional parallelization.
  • Keep the dependencies to the bare minimum to encourage other libraries to depend on Choclo.

Project status

Choclo is ready for use but still changing. This means that we sometimes break backwards compatibility as we try to improve the software based on user experience, new ideas, better design decisions, etc. Please keep that in mind before you update Choclo to a newer version.

We welcome feedback and ideas! This is a great time to bring new ideas on how we can improve the project. Join the conversation or submit issues on GitHub.

Getting involved

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

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

🧑🏾‍🤝‍🧑🏼 Code of conduct: This project is released with a Code 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 your head that is telling you that you're not ready, that you aren't skilled enough to contribute. We assure you that the little voice in your head is wrong. Most importantly, there are many valuable ways to contribute besides writing code.

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.