Changelog#

Version 0.4.0#

Released on: 2026/10/29

doi: https://doi.org/10.5281/zenodo.23780112

New features:

  • Add third derivatives of the inverse distance function (#134)

  • Extend support to Python 3.15 (#191)

Documentation:

  • Add a link to the Fatiando Forum in the README (#126)

  • Fix equations in docstring of point mass kernels (#133)

  • Fix notation on dipole magnetic field docstrings (#132)

  • Remove level 2 headings from API docs (#135)

  • Make the README banner the h1 element (#167)

  • General improvements to install and version compatibility pages (#168)

  • Add link to the AUTHORS file in the docs navigation (#169)

  • Add a link to the AI policy of Fatiando ecosystem (#183)

Breaking changes:

  • Drop support for Python 3.8 and add Python 3.13 (#131)

  • Drop support for Python 3.9 and 3.10 (#187)

Maintenance:

  • Use -e option globally in docs.yml (#127)

  • Move coverage.py configuration to pyproject.toml (#128)

  • Pin third-party GitHub Actions to a commit hash (#129)

  • Move to a src layout (#130)

  • Update pypi-publish GitHub Action to v1.13.0 (#140)

  • Remove unused variables in test functions (#144)

  • Use src/choclo as source in coverage configuration (#145)

  • Ignore division by zero warning in point test (#143)

  • Fix upload of coverage report to codecov (#147)

  • Allow zizmor’s ref-pinning of first-party actions (#156)

  • Use codecov environment in GitHub Action (#160)

  • Replace Codecov for custom HTML report in Actions (#162)

  • Remove the .codecov.yml file (#163)

  • Remove CITATION.rst of the main page (#170)

  • Add Arthur as an author of the project (#171)

  • Fix cache poisoning vulnerability in GitHub Actions (#172)

  • Fix Ruff complain about use of datetime.date.today() (#178)

  • Pin linters and update them through dependabot (#181)

  • Add Arthur in the author’s list (#184)

  • Fix variable type in dependabot configuration (#182)

  • Fix bash configuration in Action workflows (#188)

  • Autofix Ruff warnings (#189)

  • Address deprecation warning for pytest class scope (#190)

  • Let dependabot manage linters in environment.yml (#186)

This release contains contributions from:

  • Santiago Soler

  • Leonardo Uieda

  • Arthur Siqueira-Macedo

  • Alejandro Vargas

Version 0.3.2#

Released on: 2025/02/11

doi: https://doi.org/10.5281/zenodo.14852111

Bug Fixes:

  • Fix bug in third order prism kernels kernel_iij that triggered division by zero errors and numerical instabilities (#118)

Maintenance:

  • Use zizmor to lint GitHub Actions for security vulnerabilities(#114)

  • Install zizmor through conda-forge in environment.yml (#115)

  • Fix zizmor error on excessive-permissions (#119)

  • Fix deployment of docs after limiting lifetime of credentials in Action workflow (#122)

  • Replace flake8, isort and black for ruff (#112)

This release contains contributions from:

  • Santiago Soler

Version 0.3.1#

Released on: 2024/11/26

doi: https://doi.org/10.5281/zenodo.14226707

Bug fixes:

  • Make 2nd and 3rd order prism kernels return np.nan on vertices (#108)

Documentation:

  • Group similar parameters in docstrings (#105)

This release contains contributions from:

  • Santiago Soler

Version 0.3.0#

Released on: 2024/10/08

doi: https://doi.org/10.5281/zenodo.13905447

Bug fixes:

  • Fix bug on safe_log and solves discontinuous magnetic fields (#100)

New features:

  • Add forward modelling functions for the magnetic gradiometry components of prisms (#97)

Maintenance:

  • Run tests with oldest dependencies on x86 macos (#83)

  • Replace _version_generated.py for _version.py in Makefile (#82)

  • Update how output variables are stored in Actions (#90)

  • Move push to codecov to its own job in Actions (#88)

  • Replace build for python-build in environment.yml (#91)

  • Simplify tests for prism magnetic forward funcs (#96)

  • Add some more tests for _safe_log (#101)

Documentation:

  • Replace Sphinx napoleon for numpydoc (#84)

  • Fix style errors in docstrings (#85)

  • Improve docstrings of magnetic_field functions (#87)

This release contains contributions from:

  • Santiago Soler

Version 0.2.0#

Released on: 2024/04/09

doi: https://doi.org/10.5281/zenodo.10951580

New features:

  • Restore kernel functions for forward modelling of point sources (#58)

Documentation:

  • Update the versions of Sphinx and its plugins, including dark theme and minor changes to the style of the docs (#64)

  • Mention SimPEG’s support and collaboration in docs (#65)

Maintenance:

  • Use pip instead of conda for the docs workflow (#63)

  • Use Burocrata to check/add license notices (#66)

  • Use Dependabot to manage GitHub Actions updates (#68)

  • Setup Trusted Publisher deployment to PyPI (#67)

  • Ditch setup.cfg and replace it with pyproject.toml (#77)

  • Replace _version_generated.py for _version.py (#80)

  • Extend support for Python 3.12 (#79)

  • Drop support for Python 3.7 (#78)

  • Update Black formatting to version 24.2 (#61)

This release contains contributions from:

  • Santiago Soler

  • Leonardo Uieda

Version 0.1.0#

Released on: 2023/05/12

doi: https://doi.org/10.5281/zenodo.7931023

Breaking changes:

  • Ditch kernel functions for point masses (#42)

  • Make Choclo functions to take only scalar inputs instead of array inputs (#50)

  • Update the value of the gravitational constant to the latest standard (#56)

Bug fixes:

  • Fix bug on non-diagonal tensor components of prisms (#27)

New features:

  • Gravity and magnetic forward models for prisms return nan on singular points (#30)

Maintenance:

  • Drop support for Python 3.6 (#29)

  • Add missing matplotlib to the dev environment (#44)

Documentation:

  • Add installation instructions to the docs (#35)

  • Improve Overview page in docs: avoid printing huge arrays, and add plots (#37)

  • Add buttons to download user guide pages (#39)

  • Add User Guide with example for building jacobians (#40)

  • Move “How to use Choclo” to its own user guide page (#41)

  • Improve math in Jacobian matrix user guide page (#43)

  • Add Zenodo doi for all versions for citation (#45)

  • Add changelog and links to docs for other versions (#46)

  • Add a logo for Choclo, based on colorful corn variations from the Andes (#48)

This release contains contributions from:

  • Santiago Soler

  • Leonardo Uieda

Version 0.0.1#

Released on: 2022/11/19

doi: https://doi.org/10.5281/zenodo.7851748

First release of Choclo, including functions for gravity and magnetic forward modelling of point sources and right-rectangular prisms. This first release will serve as a test of the API concept as we trial the use Choclo in other projects.

This release contains contributions from:

  • Santiago Soler

  • Leonardo Uieda