choclo

Kernel functions for your geophysical models

https://github.com/fatiando/choclo

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

fatiando-a-terra geophysics gravity magnetism numba python

Keywords from Contributors

geoscience scipy-stack
Last synced: 6 months ago · JSON representation ·

Repository

Kernel functions for your geophysical models

Basic Info
Statistics
  • Stars: 15
  • Watchers: 8
  • Forks: 4
  • Open Issues: 11
  • Releases: 6
Topics
fatiando-a-terra geophysics gravity magnetism numba python
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Authors

README.md

Choclo

Kernel functions for your geophysical models

Documentation (latest)Documentation (main branch)ContributingContactAsk a question

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.

Owner

  • Name: Fatiando a Terra
  • Login: fatiando
  • Kind: organization

Open-source Python tools for geophysics

Citation (CITATION.rst)

Citing Choclo
=============

This is research software **made by scientists**. Citations help us justify the
effort that goes into building and maintaining this project.

If you used Choclo in your research, please consider
citing the latest Zenodo archive: https://doi.org/10.5281/zenodo.7851747

GitHub Events

Total
  • Create event: 26
  • Release event: 1
  • Issues event: 5
  • Watch event: 2
  • Delete event: 21
  • Issue comment event: 8
  • Push event: 92
  • Pull request review event: 11
  • Pull request review comment event: 8
  • Pull request event: 50
  • Fork event: 1
Last Year
  • Create event: 26
  • Release event: 1
  • Issues event: 5
  • Watch event: 2
  • Delete event: 21
  • Issue comment event: 8
  • Push event: 92
  • Pull request review event: 11
  • Pull request review comment event: 8
  • Pull request event: 50
  • Fork event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 49
  • Total Committers: 3
  • Avg Commits per committer: 16.333
  • Development Distribution Score (DDS): 0.571
Past Year
  • Commits: 35
  • Committers: 3
  • Avg Commits per committer: 11.667
  • Development Distribution Score (DDS): 0.486
Top Committers
Name Email Commits
Santiago Soler s****r@g****m 21
Santiago Soler s****r@f****m 18
Leonardo Uieda l****a@g****m 10
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 24
  • Total pull requests: 131
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.45
  • Merged pull requests: 119
  • Bot issues: 0
  • Bot pull requests: 21
Past Year
  • Issues: 9
  • Pull requests: 57
  • Average time to close issues: 4 days
  • Average time to close pull requests: 6 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.22
  • Average comments per pull request: 0.26
  • Merged pull requests: 47
  • Bot issues: 0
  • Bot pull requests: 13
Top Authors
Issue Authors
  • santisoler (15)
  • leouieda (7)
  • Xonxt (1)
Pull Request Authors
  • santisoler (98)
  • dependabot[bot] (36)
  • leouieda (35)
  • LL-Geo (1)
Top Labels
Issue Labels
maintenance (7) enhancement (6) documentation (4) question (3) good first issue (1) bug (1)
Pull Request Labels
dependencies (36) github_actions (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 5,303 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 2
pypi.org: choclo

Kernel functions for your geophysical models

  • Versions: 6
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 5,303 Last month
Rankings
Dependent packages count: 2.9%
Stargazers count: 19.5%
Average: 21.4%
Downloads: 23.4%
Forks count: 30.5%
Dependent repos count: 30.6%
Maintainers (2)
Last synced: 6 months ago

Dependencies

env/requirements-build.txt pypi
  • build *
  • twine *
env/requirements-docs.txt pypi
  • numba *
  • numpy *
  • sphinx ==4.5.
  • sphinx-book-theme ==0.3.
  • sphinx-copybutton ==0.5.
  • sphinx-design ==0.1.
env/requirements-style.txt pypi
  • black *
  • flake8 *
  • flake8-bugbear *
  • flake8-builtins *
  • flake8-functions *
  • flake8-mutable *
  • flake8-rst-docstrings *
  • flake8-simplify *
  • flake8-unused-arguments *
  • isort *
  • pathspec *
  • pep8-naming *
env/requirements-test.txt pypi
  • coverage * test
  • pytest * test
  • pytest-cov * test
.github/workflows/docs.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/checkout 28c7f3d2b5162b5ddd3dfd9a45aa55eaf396478b composite
  • actions/download-artifact v2 composite
  • actions/upload-artifact v2 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/pypi.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish bce3b74dbf8cc32833ffba9d15f83425c1a736e0 composite
.github/workflows/style.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/test.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v4 composite
  • styfle/cancel-workflow-action 148d9a848c6acaf90a3ec30bc5062f646f8a4163 composite
pyproject.toml pypi
environment.yml conda
  • black
  • build
  • coverage
  • flake8
  • flake8-bugbear
  • flake8-builtins
  • flake8-functions
  • flake8-mutable
  • flake8-rst-docstrings
  • flake8-simplify
  • flake8-unused-arguments
  • isort
  • jupyter-sphinx 0.5.*
  • make
  • matplotlib
  • numba
  • numpy
  • numpydoc 1.7.*
  • pathspec
  • pep8-naming
  • pip
  • pytest
  • pytest-cov
  • python 3.12
  • sphinx 7.2.*
  • sphinx-book-theme 1.1.*
  • sphinx-copybutton 0.5.*
  • sphinx-design 0.5.*
  • twine