From 45948da02fec4a32290b6850f4585a85b912d346 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Fri, 12 May 2023 13:33:10 -0700 Subject: [PATCH] Add changelog for v0.1.0 (#55) Add changelog and link to the docs for the new version. Force using https for links to previous documentation pages. --- doc/changes.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ doc/versions.rst | 7 ++++--- 2 files changed, 48 insertions(+), 3 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index c1e5eaa4..2a07ba2b 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -3,6 +3,50 @@ Changelog ========= +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 ------------- diff --git a/doc/versions.rst b/doc/versions.rst index 54f1ec4a..adc086b2 100644 --- a/doc/versions.rst +++ b/doc/versions.rst @@ -4,8 +4,9 @@ Documentation for other versions Use the links below to access documentation for specific versions (when in doubt, use the **latest release**): -* `Latest release `__ -* `Development `__ +* `Latest release `__ +* `Development `__ (reflects the current development branch on GitHub) -* `v0.0.1 `__ +* `v0.1.0 `__ +* `v0.0.1 `__