diff --git a/docs/src/whatsnew/3.7.rst b/docs/src/whatsnew/3.7.rst new file mode 100644 index 0000000000..d5ea21f3d7 --- /dev/null +++ b/docs/src/whatsnew/3.7.rst @@ -0,0 +1,158 @@ +.. include:: ../common_links.inc + +v3.7 (16 Aug 2023) [release candidate] +************************************** + +This document explains the changes made to Iris for this release +(:doc:`View all changes `.) + + +.. dropdown:: v3.7 Release Highlights + :color: primary + :icon: info + :animate: fade-in + :open: + + There are no major feature highlights for this release of Iris, but it's worth + noting that, in addition to some important bug fixes in specific areas, this time + we have made a number of improvements for user-experience and usability, + notably : + + * improved messaging for :ref:`CubeList.concatenate() ` + and :ref:`Cube.convert_units() `. + + * avoid warnings which may occur in :ref:`pp loading ` + and :ref:`contourf `. + + * :ref:`documentation supports Dark mode `. + + * :ref:`added a "Dask Best Practices" guide ` + ( :ref:`here ` ) . + + * :ref:`improved the Installation Guide `. + + Please do get in touch with us on :issue:`GitHub` if you have + any issues or feature requests for improving Iris. Enjoy! + + +📢 Announcements +================ + +#. N/A + + +✨ Features +=========== + +#. `@rcomer`_ rewrote :func:`~iris.util.broadcast_to_shape` so it now handles + lazy data. (:pull:`5307`) + + .. _concat_warnings: + +#. `@acchamber`_ added error and warning messages about coordinate overlaps to + :func:`~iris.cube.CubeList.concatenate` to improve the concatenation process. + (:pull:`5382`) + +#. `@trexfeathers`_ included mesh location coordinates + (e.g. :attr:`~iris.experimental.ugrid.Mesh.face_coords`) in + the data variable's ``coordinates`` attribute when saving to NetCDF. + (:issue:`5206`, :pull:`5389`) + +#. `@pp-mo`_ modified the install process to record the release version of the CF + standard-names table, when it creates the ``iris/std_names.py`` module. + The release number is also now available as + ``iris.std_names.CF_STANDARD_NAMES_TABLE_VERSION``. + (:pull:`5423`) + + +🐛 Bugs Fixed +============= + +#. `@acchamber`_ fixed a bug with :func:`~iris.util.unify_time_units` so it does not block + concatenation through different data types in rare instances. (:pull:`5372`) + +#. `@acchamber`_ removed some obsolete code that prevented extraction of time points + from cubes with bounded times (:pull:`5175`) + + .. _cftime_warnings: + +#. `@rcomer`_ modified pp-loading to avoid a ``cftime`` warning for non-standard + calendars. (:pull:`5357`) + +#. `@rsdavies`_ modified the CF compliant standard name for m01s00i023 (:issue:`4566`) + + +💣 Incompatible Changes +======================= + +#. N/A + + +🚀 Performance Enhancements +=========================== + +#. `@rcomer`_ made :meth:`~iris.cube.Cube.aggregated_by` faster. (:pull:`4970`) + +🔥 Deprecations +=============== + +#. N/A + + +🔗 Dependencies +=============== + +#. N/A + +📚 Documentation +================ +.. _docs_dark: + +#. `@tkknight`_ prepared the documentation for dark mode and enable the option + to use it. By default the theme will be based on the users system settings, + defaulting to ``light`` if no system setting is found. (:pull:`5299`) + + .. _dask_guide: + +#. `@HGWright`_ added a :doc:`/further_topics/dask_best_practices/index` + section into the user guide, containing advice and use cases to help users + get the best out of Dask with Iris. (:pull:`5190`) + + .. _convert_docs: + +#. `@acchamber`_ improved documentation for :meth:`~iris.cube.Cube.convert_units` + and :meth:`~iris.coords.Coord.convert_units` by including a link to the UDUNITS-2 + documentation which contains lists of compatible units and aliases for them. + (:pull:`5388`) + + .. _installdocs_update: + +#. `@rcomer`_ updated the :ref:`Installation Guide` to reflect + that some things are now simpler. (:pull:`5416`) + + +💼 Internal +=========== + +#. `@pp-mo`_ supported loading and saving netcdf :class:`netCDF4.Dataset` compatible + objects in place of file-paths, as hooks for a forthcoming + `"Xarray bridge" `_ facility. + (:pull:`5214`, :pull:`5212`) + + .. _contour_future: + +#. `@rcomer`_ updated :func:`~iris.plot.contourf` to avoid using functionality + that is deprecated in Matplotlib v3.8 (:pull:`5405`) + + + +.. comment + Whatsnew author names (@github name) in alphabetical order. Note that, + core dev names are automatically included by the common_links.inc: +.. _@rsdavies: https://github.com/rsdavies +.. _@acchamber: https://github.com/acchamber + + + +.. comment + Whatsnew resources in alphabetical order: diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index dce7458a13..c556f82761 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -12,6 +12,7 @@ What's New in Iris :hidden: latest.rst + 3.7.rst 3.6.rst 3.5.rst 3.4.rst diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index b500029789..72b74bdf42 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -30,35 +30,13 @@ This document explains the changes made to Iris for this release ✨ Features =========== -#. `@rcomer`_ rewrote :func:`~iris.util.broadcast_to_shape` so it now handles - lazy data. (:pull:`5307`) - -#. `@acchamber`_ added error and warning messages about coordinate overlaps to - :func:`~iris.cube.concatenate` to improve the concatenation process. (:pull:`5382`) - -#. `@trexfeathers`_ included mesh location coordinates - (e.g. :attr:`~iris.experimental.ugrid.Mesh.face_coords`) in - the data variable's ``coordinates`` attribute when saving to NetCDF. - (:issue:`5206`, :pull:`5389`) - -#. `@pp-mo`_ modified the install process to record the release version of the CF - standard-names table, when it creates the ``iris/std_names.py`` module. - The release number is also now available as - ``iris.std_names.CF_STANDARD_NAMES_TABLE_VERSION``. - (:pull:`5423`) +#. N/A 🐛 Bugs Fixed ============= -#. `@acchamber`_ fixed a bug with :func:`~iris.util.unify_time_units` so it does not block - concatenation through different data types in rare instances. (:pull:`5372`) - -#. `@acchamber`_ removed some obsolete code that prevented extraction of time points - from cubes with bounded times (:pull:`5175`) - -#. `@rcomer`_ modified pp-loading to avoid a ``cftime`` warning for non-standard - calendars. (:pull:`5357`) +#. N/A 💣 Incompatible Changes @@ -70,8 +48,8 @@ This document explains the changes made to Iris for this release 🚀 Performance Enhancements =========================== -#. `@rcomer`_ made :meth:`~iris.cube.Cube.aggregated_by` faster. (:pull:`4970`) -#. `@rsdavies`_ modified the CF compliant standard name for m01s00i023 :issue:`4566` +#. N/A + 🔥 Deprecations =============== @@ -88,40 +66,19 @@ This document explains the changes made to Iris for this release 📚 Documentation ================ -#. `@tkknight`_ prepared the documentation for dark mode and enable the option - to use it. By default the theme will be based on the users system settings, - defaulting to ``light`` if no system setting is found. (:pull:`5299`) - -#. `@HGWright`_ added a :doc:`/further_topics/dask_best_practices/index` - section into the user guide, containing advice and use cases to help users - get the best out of Dask with Iris. - -#. `@acchamber`_ improved documentation for :meth:`~iris.cube.Cube.convert_units` - and :meth:`~iris.coords.Coord.convert_units` by including a link to the UDUNITS-2 - documentation which contains lists of compatible units and aliases for them. +#. N/A -#. `@rcomer`_ updated the :ref:`Installation Guide` to reflect - that some things are now simpler. (:pull:`5416`) 💼 Internal =========== -#. `@pp-mo`_ supported loading and saving netcdf :class:`netCDF4.Dataset` compatible - objects in place of file-paths, as hooks for a forthcoming - `"Xarray bridge" `_ facility. - (:pull:`5214`) - -#. `@rcomer`_ updated :func:`~iris.plot.contourf` to avoid using functionality - that is deprecated in Matplotlib v3.8 (:pull:`5405`) +#. N/A .. comment Whatsnew author names (@github name) in alphabetical order. Note that, core dev names are automatically included by the common_links.inc: -.. _@rsdavies: https://github.com/rsdavies -.. _@acchamber: https://github.com/acchamber - .. comment