From 75ff780642423c6617c90ea7476a545adbca08d8 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Wed, 16 Aug 2023 16:14:01 +0100 Subject: [PATCH 1/3] V3.7.x.updates (#5424) * Whats new updates for v3.7.0rc0 . --- docs/src/whatsnew/{latest.rst => 3.7.rst} | 54 ++++++++--- docs/src/whatsnew/index.rst | 4 +- docs/src/whatsnew/latest.rst.template | 107 ---------------------- 3 files changed, 45 insertions(+), 120 deletions(-) rename docs/src/whatsnew/{latest.rst => 3.7.rst} (71%) delete mode 100644 docs/src/whatsnew/latest.rst.template diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/3.7.rst similarity index 71% rename from docs/src/whatsnew/latest.rst rename to docs/src/whatsnew/3.7.rst index b500029789..237e2873cb 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/3.7.rst @@ -1,23 +1,37 @@ .. include:: ../common_links.inc -|iris_version| |build_date| [unreleased] -**************************************** +v3.7 (16 Aug 2023) [release candidate] +************************************** This document explains the changes made to Iris for this release (:doc:`View all changes `.) -.. dropdown:: |iris_version| Release Highlights +.. dropdown:: v3.7 Release Highlights :color: primary :icon: info :animate: fade-in :open: - The highlights for this major/minor release of Iris include: + 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 : - * N/A + * improved messaging for :ref:`CubeList.concatenate() ` + and :ref:`Cube.convert_units() `. - And finally, get in touch with us on :issue:`GitHub` if you have + * 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! @@ -33,8 +47,11 @@ This document explains the changes made to Iris for this release #. `@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`) +.. _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 @@ -57,9 +74,13 @@ This document explains the changes made to Iris for this release #. `@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 ======================= @@ -71,7 +92,6 @@ This document explains the changes made to Iris for this release =========================== #. `@rcomer`_ made :meth:`~iris.cube.Cube.aggregated_by` faster. (:pull:`4970`) -#. `@rsdavies`_ modified the CF compliant standard name for m01s00i023 :issue:`4566` 🔥 Deprecations =============== @@ -88,17 +108,27 @@ This document explains the changes made to Iris for this release 📚 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. + 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`) @@ -109,7 +139,9 @@ This document explains the changes made to Iris for this release #. `@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:`5214`, :pull:`5212`) + +.. _contour_future: #. `@rcomer`_ updated :func:`~iris.plot.contourf` to avoid using functionality that is deprecated in Matplotlib v3.8 (:pull:`5405`) diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index dce7458a13..d2a15be1f7 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -5,13 +5,13 @@ What's New in Iris ------------------ -.. include:: latest.rst +.. include:: 3.7.rst .. toctree:: :maxdepth: 1 :hidden: - latest.rst + 3.7.rst 3.6.rst 3.5.rst 3.4.rst diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template deleted file mode 100644 index 966a91e976..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: From fccf9e603b694f3cf682028a3f3b35402422bd16 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 18 Aug 2023 11:18:04 +0100 Subject: [PATCH 2/3] Tweak indents to fix list numbering. (#5427) --- docs/src/whatsnew/3.7.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/src/whatsnew/3.7.rst b/docs/src/whatsnew/3.7.rst index 237e2873cb..d5ea21f3d7 100644 --- a/docs/src/whatsnew/3.7.rst +++ b/docs/src/whatsnew/3.7.rst @@ -47,7 +47,7 @@ This document explains the changes made to Iris for this release #. `@rcomer`_ rewrote :func:`~iris.util.broadcast_to_shape` so it now handles lazy data. (:pull:`5307`) -.. _concat_warnings: + .. _concat_warnings: #. `@acchamber`_ added error and warning messages about coordinate overlaps to :func:`~iris.cube.CubeList.concatenate` to improve the concatenation process. @@ -74,7 +74,7 @@ This document explains the changes made to Iris for this release #. `@acchamber`_ removed some obsolete code that prevented extraction of time points from cubes with bounded times (:pull:`5175`) -.. _cftime_warnings: + .. _cftime_warnings: #. `@rcomer`_ modified pp-loading to avoid a ``cftime`` warning for non-standard calendars. (:pull:`5357`) @@ -104,35 +104,33 @@ This document explains the changes made to Iris for this release #. 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: + .. _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: + .. _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: + .. _installdocs_update: #. `@rcomer`_ updated the :ref:`Installation Guide` to reflect that some things are now simpler. (:pull:`5416`) + 💼 Internal =========== @@ -141,7 +139,7 @@ This document explains the changes made to Iris for this release `"Xarray bridge" `_ facility. (:pull:`5214`, :pull:`5212`) -.. _contour_future: + .. _contour_future: #. `@rcomer`_ updated :func:`~iris.plot.contourf` to avoid using functionality that is deprecated in Matplotlib v3.8 (:pull:`5405`) From f21f4c47fe358c64fce2533550168e157381860b Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 17 Aug 2023 17:51:05 +0100 Subject: [PATCH 3/3] Restore latest Whats New files. --- docs/src/whatsnew/index.rst | 3 +- docs/src/whatsnew/latest.rst | 85 ++++++++++++++++++++ docs/src/whatsnew/latest.rst.template | 107 ++++++++++++++++++++++++++ 3 files changed, 194 insertions(+), 1 deletion(-) create mode 100644 docs/src/whatsnew/latest.rst create mode 100644 docs/src/whatsnew/latest.rst.template diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index d2a15be1f7..c556f82761 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -5,12 +5,13 @@ What's New in Iris ------------------ -.. include:: 3.7.rst +.. include:: latest.rst .. toctree:: :maxdepth: 1 :hidden: + latest.rst 3.7.rst 3.6.rst 3.5.rst diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst new file mode 100644 index 0000000000..72b74bdf42 --- /dev/null +++ b/docs/src/whatsnew/latest.rst @@ -0,0 +1,85 @@ +.. 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! + + +📢 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: diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template new file mode 100644 index 0000000000..966a91e976 --- /dev/null +++ b/docs/src/whatsnew/latest.rst.template @@ -0,0 +1,107 @@ +.. 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: