From d76477a04182954799e2b07065d07bfde3f6c883 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20BRIOL?= Date: Wed, 6 Nov 2024 08:00:55 +0100 Subject: [PATCH] Add changelog for version 2024.11.0 and update index.rst to include it --- docs/source/changelog.rst | 52 +++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 7 +++--- 2 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 docs/source/changelog.rst diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst new file mode 100644 index 0000000..8d4e6c6 --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1,52 @@ +.. _changelog: + +Changelog +######### + +2024.11.0 +========= + +New Features +------------ +* Added GitHub issue templates for bug reports and feature requests to improve + user support and issue tracking. + +Build System +------------ +* Updated the pre-commit configuration to use the latest versions of hooks: + * pre-commit updated from v4.6.0 to v5.0.0. + * pyupgrade updated from v3.16.0 to v3.19.0. + * flake8 updated from 7.1.0 to 7.1.1. + * clang-format updated from v18.1.8 to v19.1.2. + * mypy updated from v1.10.1 to v1.13.0. +* Disabled docformatter in pre-commit hooks. +* Set CMake policy CMP0167 to NEW for improved compatibility. + +Documentation +------------- +* Added detailed introduction and data sections to the documentation. +* Included bibliography and credits in the documentation. +* Added configuration classes to the API reference: + * pyfes.config.Common + * pyfes.config.Cartesian + * pyfes.config.LGP +* Updated examples with additional explanations and warnings regarding the use + of tidal models. + +Miscellaneous +------------- + +* Minor updates and improvements to code comments and docstrings. + +2024.6.0 +======== + +New Features +------------ + +* Added support for the LGP discretization in the tidal model. +* Rewrote the library in C++ to enhance performance and maintainability. +* Rewrote the Python bindings to the C++ library using pybind11. +* Rewrote the documentation to reflect the changes in the library. +* Added support for the latest tide atlas files from AVISO and the latest + tidal model FES 2022. diff --git a/docs/source/index.rst b/docs/source/index.rst index 7214df6..27fb65e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -27,7 +27,7 @@ Bibliography correction, in preparation, to be submitted to Ocean Sciences in 2024. * Lyard, F. H., Allain, D. J., Cancet, M., Carrère, L., and Picot, N.: FES2014 - global ocean tide atlas: design and performance, Ocean Sci., 17, 615–649, + global ocean tide atlas: design and performance, Ocean Sci., 17, 615-649, https://doi.org/10.5194/os-17-615-2021, 2021. * Carrere L., F. Lyard, M. Cancet, A. Guillot, N. Picot: FES 2014, a new tidal @@ -36,8 +36,8 @@ Bibliography Credits ------- -When using FES2022, please mention: ``FES2022 was produced by LEGOS, NOVELTIS and -CLS Ocean and Climate Division; the project was funded by CNES. It is +When using FES2022, please mention: ``FES2022 was produced by LEGOS, NOVELTIS +and CLS Ocean and Climate Division; the project was funded by CNES. It is distributed by AVISO, with support from CNES (http://www.aviso.altimetry.fr/)`` Contact @@ -50,6 +50,7 @@ Contact :maxdepth: 1 :caption: Contents: + changelog setup conda auto_examples/index.rst