Skip to main content

Kernel functions for your geophysical models

Project description

Choclo

Kernel functions for your geophysical models

Documentation (latest)Documentation (main branch)ContributingContact

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

choclo-0.3.2.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

choclo-0.3.2-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

Details for the file choclo-0.3.2.tar.gz.

File metadata

  • Download URL: choclo-0.3.2.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for choclo-0.3.2.tar.gz
Algorithm Hash digest
SHA256 043decfb7cf79d2c8c617b718433ed5713905d7e3d6d00f4d9f1022fc3fe1fdd
MD5 ee788a70bcaa1704f08cc363a5ac1ed6
BLAKE2b-256 f6d0facb77c7aee308147040163f22f1ae90be35623586916ec76822cc083b4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for choclo-0.3.2.tar.gz:

Publisher: pypi.yml on fatiando/choclo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file choclo-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: choclo-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 54.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for choclo-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ff6a54be6b452faca66ab87a66db02e801fd27556b902a881d072b789e648b63
MD5 16fb993d0fa266f13c25c15092b0c8c4
BLAKE2b-256 c38ab1caeee606a5b981b548beb813f38cd7128b5dee9cfdb1515a9402359d2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for choclo-0.3.2-py3-none-any.whl:

Publisher: pypi.yml on fatiando/choclo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page