Repository files navigation

Documentation (latest) •Documentation (main branch) •Contributing •Contact •Ask a question

Part of theFatiandoa Terra project, built in collaboration withSimPEG

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

• Provide optimized kernel functions for gravity and magnetic forward andinverse models that can be easily harnessed by different geophysicallibraries.
• Generate a pure-Python library that could be easily distributed and installedon any operating system.
• Rely onNumba for just-in-time compilations andoptional parallelization.
• Keep the dependencies to the bare minimum to encourage other libraries todepend on Choclo.

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

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

🗨️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.