diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/3.10.rst similarity index 81% rename from docs/src/whatsnew/latest.rst rename to docs/src/whatsnew/3.10.rst index 4343b02f6e..419f3e5295 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/3.10.rst @@ -1,21 +1,35 @@ .. include:: ../common_links.inc -|iris_version| |build_date| [unreleased] -**************************************** +v3.10 (30 Jul 2024 [release candidate]) +*************************************** This document explains the changes made to Iris for this release (:doc:`View all changes `.) -.. dropdown:: |iris_version| Release Highlights +.. dropdown:: v3.10 Release Highlights :color: primary :icon: info :animate: fade-in :open: - The highlights for this major/minor release of Iris include: + The highlights for this minor release of Iris include: + + * Breaking Change: We have moved all of the mesh API from :mod:`iris.experimental.ugrid` to + :mod:`iris.mesh`. This is no longer experimental making this public supported API. + + * We have made a suite of mesh improvements, there is a separate entry below for each of these changes . + + * We have made :meth:`~iris.coords.guess_bounds` capable of setting bounds to the start and end of months and years. + + * We have significantly reduced warning noise during NetCDF loading. The datum :class:`python:FutureWarning` + will now only be raised if the + ``datum_support`` :class:`~iris.Future` flag is disabled AND a datum is + present on the loaded NetCDF grid mapping. + + * Checkout the performance enhancements section for an array of improvements to the performance of Iris. + Special thanks to the `ESMValTool`_ devs for these contributions. - * N/A And finally, get in touch with us on :issue:`GitHub` if you have any issues or feature requests for improving Iris. Enjoy! @@ -24,7 +38,12 @@ This document explains the changes made to Iris for this release 📢 Announcements ================ -#. N/A +#. Breaking Change: We have moved all of the mesh API from :mod:`iris.experimental.ugrid` to + :mod:`iris.mesh`. This is no longer experimental making this public supported API. + Future changes will honour Semantic Versioning - i.e. breaking changes will only be in major releases, + and ideally will be previewed via :class:`iris.Future` flags. + +#. Note that Iris is currently pinned to NumPy ``<2``, we hope to unpin this in the next minor release (Iris v3.11). ✨ Features @@ -127,7 +146,7 @@ This document explains the changes made to Iris for this release 🔥 Deprecations =============== -#. N/A +None! 🔗 Dependencies @@ -147,12 +166,15 @@ This document explains the changes made to Iris for this release See : https://github.com/matplotlib/matplotlib/issues/28567 (:pull:`6065`) +#. Note that Iris is currently pinned to NumPy ``<2``, we hope to unpin this in the next minor release (Iris v3.11). + 📚 Documentation ================ -#. `@hsteptoe`_ added more detailed examples to :class:`~iris.cube.Cube` functions :func:`~iris.cube.Cube.slices` and :func:`~iris.cube.Cube.slices_over`. (:pull:`5735`) +#. `@hsteptoe`_ added more detailed examples to :class:`~iris.cube.Cube` functions + :func:`~iris.cube.Cube.slices` and :func:`~iris.cube.Cube.slices_over`. (:pull:`5735`) 💼 Internal @@ -220,3 +242,4 @@ This document explains the changes made to Iris for this release Whatsnew resources in alphabetical order: .. _airspeed-velocity/asv#1397: https://github.com/airspeed-velocity/asv/pull/1397 +.. _ESMValTool: https://github.com/ESMValGroup/ESMValTool diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index 012e0b4498..45a5cad727 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -6,13 +6,13 @@ What's New in Iris ------------------ -.. include:: latest.rst +.. include:: 3.10.rst .. toctree:: :maxdepth: 1 :hidden: - latest.rst + 3.10.rst 3.9.rst 3.8.rst 3.7.rst diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template deleted file mode 100644 index 80bf48dadd..0000000000 --- a/docs/src/whatsnew/latest.rst.template +++ /dev/null @@ -1,107 +0,0 @@ -.. include:: ../common_links.inc - -|iris_version| |build_date| [unreleased] -**************************************** - -This document explains the changes made to Iris for this release -(:doc:`View all changes `.) - - -.. dropdown:: |iris_version| Release Highlights - :color: primary - :icon: info - :animate: fade-in - :open: - - The highlights for this major/minor release of Iris include: - - * N/A - - And finally, get in touch with us on :issue:`GitHub` if you have - any issues or feature requests for improving Iris. Enjoy! - - -NOTE: section BELOW is a template for bugfix patches -==================================================== - (Please remove this section when creating an initial 'latest.rst' - -|iris_version| |build_date| -=========================== - -.. dropdown:: |iris_version| Patches - :color: primary - :icon: alert - :animate: fade-in - - The patches in this release of Iris include: - - #. N/A - -NOTE: section ABOVE is a template for bugfix patches -==================================================== - (Please remove this section when creating an initial 'latest.rst') - - -📢 Announcements -================ - -#. N/A - - -✨ Features -=========== - -#. N/A - - -🐛 Bugs Fixed -============= - -#. N/A - - -💣 Incompatible Changes -======================= - -#. N/A - - -🚀 Performance Enhancements -=========================== - -#. N/A - - -🔥 Deprecations -=============== - -#. N/A - - -🔗 Dependencies -=============== - -#. N/A - - -📚 Documentation -================ - -#. N/A - - -💼 Internal -=========== - -#. N/A - - -.. comment - Whatsnew author names (@github name) in alphabetical order. Note that, - core dev names are automatically included by the common_links.inc: - - - - -.. comment - Whatsnew resources in alphabetical order: \ No newline at end of file