Skip to content

Commit

Permalink
Merge pull request #5310 from bjlittle/v3.6.x.mergeback
Browse files Browse the repository at this point in the history 
V3.6.x.mergeback
  • Loading branch information
@trexfeathers
trexfeathers authored May 9, 2023
2 parents 90e2c1d + 387b2af commit 39e9feb
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 85 deletions.
160 changes: 160 additions & 0 deletions docs/src/whatsnew/3.6.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
.. include:: ../common_links.inc

v3.6 (03 May 2023) [release candidate]
**************************************

This document explains the changes made to Iris for this release
(:doc:`View all changes <index>`.)


.. dropdown:: v3.6 Release Highlights
:color: primary
:icon: info
:animate: fade-in
:open:

We're so excited about our recent support for **delayed saving of lazy data
to netCDF** (:pull:`5191`) that we're celebrating this important step change
in behavour with its very own dedicated release 🥳

We're super keen for the community to leverage the benefit of this new
feature within Iris that we've brought this release forward several months.
As a result, this minor release of Iris is intentionally light in content.
However, there are some other goodies available for you to enjoy, such as:

* Performing lazy arithmetic with an Iris :class:`~iris.cube.Cube` and a
:class:`dask.array.Array`, and
* Various improvements to our documentation resulting from adoption of
`sphinx-design`_ and `sphinx-apidoc`_.

As always, get in touch with us on :issue:`GitHub<new/choose>`, particularly
if you have any feedback with regards to delayed saving, or have any issues
or feature requests for improving Iris. Enjoy!


📢 Announcements
================

#. `@bjlittle`_ added the community `Contributor Covenant`_ code of conduct.
(:pull:`5291`)


✨ Features
===========

#. `@pp-mo`_ and `@lbdreyer`_ supported delayed saving of lazy data, when writing to
the netCDF file format. See :ref:`delayed netCDF saves <delayed_netcdf_save>`.
Also with significant input from `@fnattino`_.
(:pull:`5191`)

#. `@rcomer`_ tweaked binary operations so that dask arrays may safely be passed
to arithmetic operations and :func:`~iris.util.mask_cube`. (:pull:`4929`)


🐛 Bugs Fixed
=============

#. `@rcomer`_ enabled automatic replacement of a Matplotlib
:class:`~matplotlib.axes.Axes` with a Cartopy
:class:`~cartopy.mpl.geoaxes.GeoAxes` when the ``Axes`` is on a
:class:`~matplotlib.figure.SubFigure`. (:issue:`5282`, :pull:`5288`)


💣 Incompatible Changes
=======================

#. N/A


🚀 Performance Enhancements
===========================

#. N/A


🔥 Deprecations
===============

#. N/A


🔗 Dependencies
===============

#. `@rcomer`_ and `@bjlittle`_ (reviewer) added testing support for python
3.11. (:pull:`5226`)

#. `@rcomer`_ dropped support for python 3.8, in accordance with the NEP29_
recommendations (:pull:`5226`)

#. `@trexfeathers`_ introduced the ``libnetcdf !=4.9.1`` and ``numpy !=1.24.3``
pins (:pull:`5274`)


📚 Documentation
================

#. `@tkknight`_ migrated to `sphinx-design`_ over the legacy `sphinx-panels`_.
(:pull:`5127`)

#. `@tkknight`_ updated the ``make`` target for ``help`` and added
``livehtml`` to auto generate the documentation when changes are detected
during development. (:pull:`5258`)

#. `@tkknight`_ updated the :ref:`installing_from_source` instructions to use
``pip``. (:pull:`5273`)

#. `@tkknight`_ removed the legacy custom sphinx extensions that generate the
API documentation. Instead use a less complex approach via
`sphinx-apidoc`_. (:pull:`5264`)

#. `@trexfeathers`_ re-wrote the :ref:`iris_development_releases` documentation
for clarity, and wrote a step-by-step
:doc:`/developers_guide/release_do_nothing` for the release process.
(:pull:`5134`)

#. `@trexfeathers`_ and `@tkknight`_ added a dark-mode friendly logo.
(:pull:`5278`)


💼 Internal
===========

#. `@bjlittle`_ added the `codespell`_ `pre-commit`_ ``git-hook`` to automate
spell checking within the code-base. (:pull:`5186`)

#. `@bjlittle`_ and `@trexfeathers`_ (reviewer) added a `check-manifest`_
GitHub Action and `pre-commit`_ ``git-hook`` to automate verification
of assets bundled within a ``sdist`` and binary ``wheel`` of our
`scitools-iris`_ PyPI package. (:pull:`5259`)

#. `@rcomer`_ removed a now redundant copying workaround from Resolve testing.
(:pull:`5267`)

#. `@bjlittle`_ and `@trexfeathers`_ (reviewer) migrated ``setup.cfg`` to
``pyproject.toml``, as motivated by `PEP-0621`_. (:pull:`5262`)

#. `@bjlittle`_ adopted `pypa/build`_ recommended best practice to build a
binary ``wheel`` from the ``sdist``. (:pull:`5266`)

#. `@trexfeathers`_ enabled on-demand benchmarking of Pull Requests; see
:ref:`here <on_demand_pr_benchmark>`. (:pull:`5286`)


.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
core dev names are automatically included by the common_links.inc:
.. _@fnattino: https://github.com/fnattino


.. comment
Whatsnew resources in alphabetical order:
.. _sphinx-panels: https://github.com/executablebooks/sphinx-panels
.. _sphinx-design: https://github.com/executablebooks/sphinx-design
.. _check-manifest: https://github.com/mgedmin/check-manifest
.. _PEP-0621: https://peps.python.org/pep-0621/
.. _pypa/build: https://pypa-build.readthedocs.io/en/stable/
.. _NEP29: https://numpy.org/neps/nep-0029-deprecation_policy.html
.. _Contributor Covenant: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
1 change: 1 addition & 0 deletions docs/src/whatsnew/index.rst
View file
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.6.rst
3.5.rst
3.4.rst
3.3.rst
Expand Down
77 changes: 7 additions & 70 deletions docs/src/whatsnew/latest.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,19 @@ This document explains the changes made to Iris for this release
📢 Announcements
================

#. `@bjlittle`_ added the community `Contributor Covenant`_ code of conduct.
(:pull:`5291`)
#. N/A


✨ Features
===========

#. `@pp-mo`_ and `@lbdreyer`_ supported delayed saving of lazy data, when writing to
the netCDF file format. See : :ref:`delayed netCDF saves <delayed_netcdf_save>`.
Also with significant input from `@fnattino`_.
(:pull:`5191`)

#. `@rcomer`_ tweaked binary operations so that dask arrays may safely be passed
to arithmetic operations and :func:`~iris.util.mask_cube`. (:pull:`4929`)
#. N/A


🐛 Bugs Fixed
=============

#. `@rcomer`_ enabled automatic replacement of a Matplotlib
:class:`~matplotlib.axes.Axes` with a Cartopy
:class:`~cartopy.mpl.geoaxes.GeoAxes` when the ``Axes`` is on a
:class:`~matplotlib.figure.SubFigure`. (:issue:`5282`, :pull:`5288`)
#. N/A


💣 Incompatible Changes
Expand All @@ -70,80 +60,27 @@ This document explains the changes made to Iris for this release
🔗 Dependencies
===============

#. `@rcomer`_ and `@bjlittle`_ (reviewer) added testing support for python
3.11. (:pull:`5226`)

#. `@rcomer`_ dropped support for python 3.8, in accordance with the NEP29_
recommendations (:pull:`5226`)

#. `@trexfeathers`_ introduced the ``libnetcdf !=4.9.1`` and ``numpy !=1.24.3``
pins (:pull:`5274`)
#. N/A


📚 Documentation
================

#. `@tkknight`_ migrated to `sphinx-design`_ over the legacy `sphinx-panels`_.
(:pull:`5127`)

#. `@tkknight`_ updated the ``make`` target for ``help`` and added
``livehtml`` to auto generate the documentation when changes are detected
during development. (:pull:`5258`)

#. `@tkknight`_ updated the :ref:`installing_from_source` instructions to use
``pip``. (:pull:`5273`)

#. `@tkknight`_ removed the legacy custom sphinx extensions that generate the
API documentation. Instead use a less complex approach via
`sphinx-apidoc`_. (:pull:`5264`)

#. `@trexfeathers`_ re-wrote the :ref:`iris_development_releases` documentation
for clarity, and wrote a step-by-step
:doc:`/developers_guide/release_do_nothing` for the release process.
(:pull:`5134`)

#. `@trexfeathers`_ and `@tkknight`_ added a dark-mode friendly logo.
(:pull:`5278`)
#. N/A


💼 Internal
===========

#. `@bjlittle`_ added the `codespell`_ `pre-commit`_ ``git-hook`` to automate
spell checking within the code-base. (:pull:`5186`)

#. `@bjlittle`_ and `@trexfeathers`_ (reviewer) added a `check-manifest`_
GitHub Action and `pre-commit`_ ``git-hook`` to automate verification
of assets bundled within a ``sdist`` and binary ``wheel`` of our
`scitools-iris`_ PyPI package. (:pull:`5259`)

#. `@rcomer`_ removed a now redundant copying workaround from Resolve testing.
(:pull:`5267`)

#. `@bjlittle`_ and `@trexfeathers`_ (reviewer) migrated ``setup.cfg`` to
``pyproject.toml``, as motivated by `PEP-0621`_. (:pull:`5262`)

#. `@bjlittle`_ adopted `pypa/build`_ recommended best practice to build a
binary ``wheel`` from the ``sdist``. (:pull:`5266`)

#. `@trexfeathers`_ enabled on-demand benchmarking of Pull Requests; see
:ref:`here <on_demand_pr_benchmark>`. (:pull:`5286`)
#. N/A


.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
core dev names are automatically included by the common_links.inc:
.. _@fnattino: https://github.com/fnattino
.. comment
Whatsnew resources in alphabetical order:
.. _sphinx-panels: https://github.com/executablebooks/sphinx-panels
.. _sphinx-design: https://github.com/executablebooks/sphinx-design
.. _check-manifest: https://github.com/mgedmin/check-manifest
.. _PEP-0621: https://peps.python.org/pep-0621/
.. _pypa/build: https://pypa-build.readthedocs.io/en/stable/
.. _NEP29: https://numpy.org/neps/nep-0029-deprecation_policy.html
.. _Contributor Covenant: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
26 changes: 11 additions & 15 deletions docs/src/whatsnew/latest.rst.template
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ This document explains the changes made to Iris for this release
(:doc:`View all changes <index>`.)


.. dropdown:: :opticon:`report` |iris_version| Release Highlights
:container: + shadow
:title: text-primary text-center font-weight-bold
:body: bg-light
.. dropdown:: |iris_version| Release Highlights
:color: primary
:icon: info
:animate: fade-in
:open:

Expand All @@ -22,29 +21,27 @@ This document explains the changes made to Iris for this release
any issues or feature requests for improving Iris. Enjoy!


NOTE: section below is a template for bugfix patches
NOTE: section BELOW is a template for bugfix patches
====================================================
(Please remove this section when creating an initial 'latest.rst')
(Please remove this section when creating an initial 'latest.rst'

v3.X.X (DD MMM YYYY)
====================
|iris_version| |build_date|
===========================

.. dropdown:: :opticon:`alert` v3.X.X Patches
:container: + shadow
:title: text-primary text-center font-weight-bold
:body: bg-light
.. 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
NOTE: section ABOVE is a template for bugfix patches
====================================================
(Please remove this section when creating an initial 'latest.rst')



📢 Announcements
================

Expand Down Expand Up @@ -108,4 +105,3 @@ NOTE: section above is a template for bugfix patches

.. comment
Whatsnew resources in alphabetical order:

0 comments on commit 39e9feb

Please sign in to comment.