Skip to content

Integrated whatsnew for v3.1 release (rc0) #4285

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

Merged
lbdreyer merged 6 commits into from
Aug 17, 2021
Merged

Integrated whatsnew for v3.1 release (rc0) #4285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8092843
Replace interim 3.0.x whatsnews with single v3.1.rst, with concrete v…
pp-mo Aug 17, 2021
ebea3b8
Mark as unreleased, fix links.
pp-mo Aug 17, 2021
4809fbd
Rearrange entries tagged 'pre-3.1', and recategorise #4176 change.
pp-mo Aug 17, 2021
b5f8b5b
Moved bugfix notes from v3.1 to v3.0 whatsnew page.
pp-mo Aug 17, 2021
886fe97
Fixed broken pull-request refs.
pp-mo Aug 17, 2021
04d22ad
Fix link to PyKE.
pp-mo Aug 17, 2021
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
518 changes: 0 additions & 518 deletions docs/src/whatsnew/3.0.1.rst
View file
Open in desktop

This file was deleted.

571 changes: 0 additions & 571 deletions docs/src/whatsnew/3.0.2.rst
View file
Open in desktop

This file was deleted.

586 changes: 0 additions & 586 deletions docs/src/whatsnew/3.0.3.rst
View file
Open in desktop

This file was deleted.

620 changes: 0 additions & 620 deletions docs/src/whatsnew/3.0.4.rst
View file
Open in desktop

This file was deleted.

84 changes: 84 additions & 0 deletions docs/src/whatsnew/3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,67 @@ This document explains the changes made to Iris for this release
#. `@rcomer`_ fixed a bug whereby numpy array type attributes on a cube's
coordinates could prevent printing it. See :issue:`3921`. (:pull:`3922`)

===================================
Bugs fixed in v3.0.1 (27 Jan 2021)
===================================

#. `@bjlittle`_ gracefully promote formula terms within :mod:`~iris.aux_factory` that have ``units`` of ``unknown``
to ``units`` of ``1`` (dimensionless), where the formula term **must** have dimensionless ``units``. Without this
graceful treatment of ``units`` the resulting :class:`~iris.cube.Cube` will **not** contain the expected auxiliary
factory, and the associated derived coordinate will be missing. (:pull:`3965`)

===================================
Bugs fixed in v3.0.2 (27 May 2021)
===================================

#. `@jonseddon`_ handled a malformed ``um_stash_source`` CF variable attribute in
a netCDF file rather than raising a ``ValueError``. (:pull:`4035`)

#. `@rcomer`_ fixed :meth:`~iris.cube.Cube.intersection` for special cases
where one cell's bounds align with the requested maximum and minimum, as
reported in :issue:`3391`. (:pull:`4059`)

#. `@bjlittle`_ resolved a regression in arithmetic behaviour between a coordinate
and a cube which resulted in a ``NotYetImplementedError`` being raised, as reported
in :issue:`4000`. This fix supports ``+``, ``-``, ``*``, and ``/`` operations
between a coordinate and a cube, and for convenience additionally includes
:meth:`iris.cube.Cube.__neg__` support. (:pull:`4159`)

===================================
Bugs fixed in v3.0.3 (07 July 2021)
===================================

#. `@lbdreyer`_ modified :meth:`~iris.cube.Cube.intersection` to use a tolerant
equality check, when looking for cells that straddle the wrapping point.
(:pull:`4220`)

===================================
Bugs fixed in v3.0.4 (22 July 2021)
===================================

#. `@pp-mo`_ fixed 2 bugs in cube printout:
Firstly, ancillary-variables or cell-measures with long names can now widen the cube "dimensions map" to fit,
whereas previously printing these cases caused an Exception.
Secondly, cube units are now always printed, whereas previously they were missed out any time that the
"dimensions map" was widened to accomodate long coordinate names.
(:pull:`4233`)(:pull:`4238`)



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

================================================
Performance Enhancements in v3.0.2 (27 May 2021)
================================================

#. `@pp-mo`_ adjusted the use of :func:`dask.array.from_array` in :func:`iris._lazy_data.as_lazy_data`,
to avoid the dask 'test access'. This makes loading of netcdf files with a
large number of variables significantly faster. (:pull:`4135`)




.. _whatsnew 3.0 changes:

💣 Incompatible Changes
Expand Down Expand Up @@ -452,6 +513,26 @@ This document explains the changes made to Iris for this release
run the Iris tests, the doc-tests, the gallery doc-tests, and lint Iris
with `flake8`_ and `black`_. (:pull:`3928`)

========================================
Internal changes in v3.0.2 (27 May 2021)
========================================

#. `@pp-mo`_ reverted a change made previously in (:pull:`3659`) to
:meth:`iris.fileformats.pp.PPDataProxy.__getitem__`. The check for empty slicings
is no longer needed since (:pull:`4135`) was added. (:pull:`4141`)

=========================================
Internal changes in v3.0.4 (22 July 2021)
=========================================
#. `@bjlittle`_ Unpinned the `cftime`_ package dependency within Iris in order
to allow use of the latest versions of `cftime`_, `cf-units`_ and `nc-time-axis`_.
(:pull:`4222`)

#. `@rcomer`_ modified test modules so they run consistently under ``pytest`` and
``nose``, and also fixed some minor issues with :class:`~iris.time.PartialDateTime`.
(:pull:`4249`)


.. _Read the Docs: https://scitools-iris.readthedocs.io/en/latest/
.. _CF units rules: https://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#units
.. _CF Ancillary Data: https://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#ancillary-data
Expand Down Expand Up @@ -500,3 +581,6 @@ This document explains the changes made to Iris for this release
.. _Title Case Capitalization: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
.. _travis-ci: https://travis-ci.org/github/SciTools/iris
.. _stickler-ci: https://stickler-ci.com/
.. _cf-units: https://github.com/SciTools/cf-units
.. _cftime: https://github.com/Unidata/cftime
.. _nc-time-axis: https://github.com/SciTools/nc-time-axis
33 changes: 23 additions & 10 deletions docs/src/whatsnew/3.1.0.rst → docs/src/whatsnew/3.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. include:: ../common_links.inc

|iris_version| |build_date|
***************************
v3.1 (17 Aug 2021) [unreleased]
*******************************
Copy link
Member

@lbdreyer lbdreyer Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I notice for the Iris 3 rc we included a date:
https://scitools-iris.readthedocs.io/en/v3.0.0rc0/whatsnew/3.0.html

Copy link
Member

@lbdreyer lbdreyer Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry wasn't clear. I meant to say just a date no unreleased

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think that's effectively a preliminary date -- the date of the RC.
Which we would change again we we make it a full release
(imho)

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've done the same, but left in the '[unreleased]' tag, because I thought that made sense..

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might also consider that it makes sense to label this with the 'rc0',
but, again, we haven't done so in the past


This document explains the changes made to Iris for this release
(:doc:`View all changes <index>`.)
Expand Down Expand Up @@ -68,7 +68,7 @@ This document explains the changes made to Iris for this release
(:pull:`4206`)

#. `@schlunma`_ added support for loading atmosphere sigma coordinates from netcdf-CF files. These now load as
:class:`iris.aux_factory.AtmosphereSigmaFactory` derived coordinates. (:pull: `4052`)
:class:`iris.aux_factory.AtmosphereSigmaFactory` derived coordinates. (:pull:`4052`)


🐛 Bugs Fixed
Expand Down Expand Up @@ -112,7 +112,6 @@ This document explains the changes made to Iris for this release
NetCDF variable name, not when matching on STASH.
(:pull:`4176`)


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

Expand All @@ -131,7 +130,7 @@ This document explains the changes made to Iris for this release
#. `@bjlittle`_ dropped both `black`_ and `flake8`_ package dependencies
from our `conda`_ YAML and ``setup.cfg`` PyPI requirements. (:pull:`4181`)

#. `@pp-mo`_ removed dependency on `PyKE_`. (:pull: `4198`)
#. `@pp-mo`_ removed dependency on `PyKE`_. (:pull:`4198`)


📚 Documentation
Expand Down Expand Up @@ -180,6 +179,9 @@ This document explains the changes made to Iris for this release
#. `@MHBalsmeier`_ updated and simplified non-conda installation on Debian-based distros.
(:pull:`4260`)

#. `@bjlittle`_ updated the ``intersphinx_mapping`` and fixed documentation
to use ``stable`` URLs for `matplotlib`_. (:pull:`4003`)


💼 Internal
===========
Expand Down Expand Up @@ -255,13 +257,23 @@ This document explains the changes made to Iris for this release
(:pull:`3987`) (:pull:`4206`)

#. `@pp-mo`_ reworked the netcdf loading code, replacing Pyke rules with a pure Python implementation.
(:pull: `4198`)

(:pull:`4198`)

#. `@lbdreyer`_ updated the CF standard name table to the latest version:
`v77 <http://cfconventions.org/Data/cf-standard-names/77/src/cf-standard-name-table.xml>`_.
(:pull:`4282`)

#. `@jamesp`_ updated a test to the latest numpy version (:pull:`3977`)

#. `@bjlittle`_ enabled `cirrus-ci`_ compute credits for non-draft pull-requests
from collaborators targeting the Iris ``master`` branch. (:pull:`4007`)

#. `@bjlittle`_ added conditional task execution to `.cirrus.yml`_ to allow
developers to easily disable `cirrus-ci`_ tasks. See
:ref:`skipping Cirrus-CI tasks`. (:pull:`4019`)



.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
core dev names are automatically included by the common_links.inc:
Expand All @@ -276,18 +288,19 @@ This document explains the changes made to Iris for this release
Whatsnew resources in alphabetical order:

.. _abstract base class: https://docs.python.org/3/library/abc.html
.. _asv: https://asv.readthedocs.io/en/stable/
.. _blacken-docs: https://github.com/asottile/blacken-docs
.. _conda-lock: https://github.com/conda-incubator/conda-lock
.. _deprecated numpy 1.20 aliases for builtin types: https://numpy.org/doc/1.20/release/1.20.0-notes.html#using-the-aliases-of-builtin-types-like-np-int-is-deprecated
.. _GitHub: https://github.com/SciTools/iris/issues/new/choose
.. _Met Office: https://www.metoffice.gov.uk/
.. _numpy: https://numpy.org/doc/stable/release/1.20.0-notes.html
.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/SciTools/iris/main.svg
.. _pre-commit.ci: https://results.pre-commit.ci/latest/github/SciTools/iris/main
.. _PyKE: https://pypi.org/project/scitools-pyke/
.. |PyPI| image:: https://img.shields.io/pypi/v/scitools-iris?color=orange&label=pypi%7Cscitools-iris
.. _PyPI: https://pypi.org/project/scitools-iris/
.. _Python 3.8: https://www.python.org/downloads/release/python-380/
.. _Python 3.6: https://www.python.org/downloads/release/python-360/
.. _Python 3.8: https://www.python.org/downloads/release/python-380/
.. _README.md: https://github.com/SciTools/iris#-----
.. _xxhash: http://cyan4973.github.io/xxHash/
.. _conda-lock: https://github.com/conda-incubator/conda-lock
.. _asv: https://asv.readthedocs.io/en/stable/
6 changes: 1 addition & 5 deletions docs/src/whatsnew/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@ Iris versions.
.. toctree::
:maxdepth: 1

3.1.0.rst
3.0.4.rst
3.0.3.rst
3.0.2.rst
3.0.1.rst
Copy link
Member

@lbdreyer lbdreyer Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pp-mo Do you know why we had separate what's news for each bug release?
Was it just there to draw attention to the fact that there multiple 3.0.x releases?

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know really.
However, I did find that we did not do this with the 2.2.1 bugfix release : there we just have a modified 2.2.rst (and no 2.2.1.rst)

Copy link
Member Author

@pp-mo pp-mo Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the 3.0.4.rst incorporates all the entries from the other 3

3.1.rst
3.0.rst
2.4.rst
2.3.rst
Expand Down