Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

V3.7.x.mergeback #5428

Merged
merged 4 commits into from
Aug 18, 2023
Merged

V3.7.x.mergeback #5428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
75ff780
V3.7.x.updates (#5424)
pp-mo Aug 16, 2023
fccf9e6
Tweak indents to fix list numbering. (#5427)
pp-mo Aug 18, 2023
1961c4f
Merging release branch into main
pp-mo Aug 18, 2023
f21f4c4
Restore latest Whats New files.
pp-mo Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions docs/src/whatsnew/3.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <index>`.)


.. 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() <concat_warnings>`
and :ref:`Cube.convert_units() <convert_docs>`.

* avoid warnings which may occur in :ref:`pp loading <cftime_warnings>`
and :ref:`contourf <contour_future>`.

* :ref:`documentation supports Dark mode <docs_dark>`.

* :ref:`added a "Dask Best Practices" guide <dask_guide>`
( :ref:`here <dask best practices>` ) .

* :ref:`improved the Installation Guide <installdocs_update>`.

Please do get in touch with us on :issue:`GitHub<new/choose>` 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<installing_iris>` 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" <https://github.com/SciTools/iris/issues/4994>`_ 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:
1 change: 1 addition & 0 deletions docs/src/whatsnew/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ What's New in Iris
:hidden:

latest.rst
3.7.rst
3.6.rst
3.5.rst
3.4.rst
Expand Down
55 changes: 6 additions & 49 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
===============
Expand All @@ -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<installing_iris>` 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" <https://github.com/SciTools/iris/issues/4994>`_ 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
Expand Down