https://github.com/fatiando/choclo

Kernel functions for your geophysical models
https://github.com/fatiando/choclo

fatiando-a-terra geophysics gravity magnetism numba python

Last synced: 5 months ago
JSON representation

Kernel functions for your geophysical models

• Host: GitHub
• URL: https://github.com/fatiando/choclo
• Owner: fatiando
• License: bsd-3-clause
• Created: 2022-08-19T18:22:52.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-21T20:29:02.000Z (8 months ago)
• Last Synced: 2025-03-04T09:34:59.188Z (7 months ago)
• Topics: fatiando-a-terra, geophysics, gravity, magnetism, numba, python
• Language: Python
• Homepage: https://www.fatiando.org/choclo
• Size: 11.1 MB
• Stars: 13
• Watchers: 8
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.rst
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          


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

















## 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](https://en.wikipedia.org/wiki/Quechuan_languages)

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](https://numba.pydata.org/) 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](https://www.fatiando.org/contact) or submit

[issues on GitHub](https://github.com/fatiando/choclo/issues).

## Getting involved

🗨️ **Contact us:**

Find out more about how to reach us at

[fatiando.org/contact](https://www.fatiando.org/contact/).

👩🏾‍💻 **Contributing to project development:**

Please read our

[Contributing Guide](https://github.com/fatiando/choclo/blob/main/CONTRIBUTING.md)

to see how you can help and give feedback.

🧑🏾‍🤝‍🧑🏼 **Code of conduct:**

This project is released with a

[Code of Conduct](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md).

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](https://github.com/Unidata/MetPy).

## 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`](https://github.com/fatiando/choclo/blob/main/LICENSE.txt).