From 10f73e80f25ea4e0caf2182261c106d1d1dbcc43 Mon Sep 17 00:00:00 2001 From: Corinne Bosley Date: Wed, 10 Oct 2018 10:44:15 +0100 Subject: [PATCH 1/5] started adding entries to whatsnew --- docs/iris/src/whatsnew/2.2.rst | 39 +++++++++++++++++-- ...ure_2018-Apr-12_fast_load_file_indices.txt | 8 ---- ...Aug-20_print-long-time-interval-bounds.txt | 2 - ...fully-filling-warning-only-when-masked.txt | 1 - .../newfeature_2018-Aug-14_load-nc-chunks.txt | 1 - .../newfeature_2018-Oct-03_reverse_cube.txt | 1 - 6 files changed, 36 insertions(+), 16 deletions(-) delete mode 100644 docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Apr-12_fast_load_file_indices.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Aug-20_print-long-time-interval-bounds.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Sep-19_gracefully-filling-warning-only-when-masked.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Aug-14_load-nc-chunks.txt delete mode 100644 docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Oct-03_reverse_cube.txt diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/iris/src/whatsnew/2.2.rst index 7b069f455e..4c0b449f81 100644 --- a/docs/iris/src/whatsnew/2.2.rst +++ b/docs/iris/src/whatsnew/2.2.rst @@ -1,11 +1,11 @@ What's New in Iris 2.2.0 ************************ -:Release: 2.2.0a0 +:Release: 2.2.0 :Date: -This document explains the new/changed features of Iris in the alpha release +This document explains the new/changed features of Iris in the release of version 2.2.0 (:doc:`View all changes `). @@ -25,7 +25,7 @@ Iris 2.2.0 Features contiguous, or the cube's data must be masked at the discontiguities in order to avoid plotting errors. - The iris plot functions :func:`iris.plot.quiver` has been added, and this + The iris plot function :func:`iris.plot.quiver` has been added, and this also works with 2-dimensional plot coordinates. .. admonition:: 2-Dimensional Grid Vectors @@ -33,3 +33,36 @@ Iris 2.2.0 Features The iris functions :func:`iris.analysis.cartography.gridcell_angles` and :func:`iris.analysis.cartography.rotate_grid_vectors` have been added, allowing you to convert gridcell-oriented vectors to true-North/East ones. + +* The :class:`iris.fileformats.um.FieldCollation` objects, which are passed + into load callbacks when using + :func:`iris.fileformats.um.structured_um_loading`, now + have the additional properties: + :data:`iris.fileformats.um.FieldCollation.data_filepath` and + :data:`iris.fileformats.um.FieldCollation.data_field_indices`. + These provide the file locations of the original data fields, which are + otherwise lost in the structured loading process. + +* NetCDF data variable chunk sizes are utilised at load time for significant + performance improvements. + +* :func:`iris.util.reverse` can now be used to reverse a cube by specifying + one or more coordinates. + + +Iris 2.1 Dependency updates +=========================== + +* Iris is now using the latest version release of Dask (currently 0.19.3) + +* + +Bugs Fixed +========== + +* Fixed a bug that prevented printing time coordinates with bounds when the + time coordinate was measured on a long interval (that is, ``months`` + or ``years``). + +* "Gracefully filling..." warnings are now only issued when the co-ordinate or + bound data is actually masked. diff --git a/docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Apr-12_fast_load_file_indices.txt b/docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Apr-12_fast_load_file_indices.txt deleted file mode 100644 index c7d74fe88f..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.1/newfeature_2018-Apr-12_fast_load_file_indices.txt +++ /dev/null @@ -1,8 +0,0 @@ -* The :class:`iris.fileformats.um.FieldCollation` objects, which are passed - into load callbacks when using - :func:`iris.fileformats.um.structured_um_loading`, now - have the additional properties : - :data:`iris.fileformats.um.FieldCollation.data_filepath` and - :data:`iris.fileformats.um.FieldCollation.data_field_indices`. - These provide the file locations of the original data fields, which are - otherwise lost in the structured loading process. diff --git a/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Aug-20_print-long-time-interval-bounds.txt b/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Aug-20_print-long-time-interval-bounds.txt deleted file mode 100644 index 3651598b72..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Aug-20_print-long-time-interval-bounds.txt +++ /dev/null @@ -1,2 +0,0 @@ -* Fixed a bug that prevented printing time coordinates with bounds when the time - coordinate was measured on a long interval (that is, ``months`` or ``years``). \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Sep-19_gracefully-filling-warning-only-when-masked.txt b/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Sep-19_gracefully-filling-warning-only-when-masked.txt deleted file mode 100644 index c720e6f07a..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.2.0/bugfix_2018-Sep-19_gracefully-filling-warning-only-when-masked.txt +++ /dev/null @@ -1 +0,0 @@ -* "Gracefully filling..." warnings are only issued when the co-ordinate or bound data is actually masked. diff --git a/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Aug-14_load-nc-chunks.txt b/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Aug-14_load-nc-chunks.txt deleted file mode 100644 index 2a3780115d..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Aug-14_load-nc-chunks.txt +++ /dev/null @@ -1 +0,0 @@ -* NetCDF data variable chunk sizes are utilised at load time for significant performance improvements. \ No newline at end of file diff --git a/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Oct-03_reverse_cube.txt b/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Oct-03_reverse_cube.txt deleted file mode 100644 index c7e3bef8a4..0000000000 --- a/docs/iris/src/whatsnew/contributions_2.2.0/newfeature_2018-Oct-03_reverse_cube.txt +++ /dev/null @@ -1 +0,0 @@ -* :func:`iris.util.reverse` can now be used to reverse a cube by specifying one or more coordinates. From bb93ee067c78031d763e34bd31552321531ea6c3 Mon Sep 17 00:00:00 2001 From: Corinne Bosley Date: Wed, 10 Oct 2018 11:33:22 +0100 Subject: [PATCH 2/5] more updates to whatsnew --- docs/iris/src/whatsnew/2.2.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/iris/src/whatsnew/2.2.rst index 4c0b449f81..217e396c02 100644 --- a/docs/iris/src/whatsnew/2.2.rst +++ b/docs/iris/src/whatsnew/2.2.rst @@ -49,13 +49,16 @@ Iris 2.2.0 Features * :func:`iris.util.reverse` can now be used to reverse a cube by specifying one or more coordinates. +* Time mean fields can now be saved to PP files as a cell method. + Iris 2.1 Dependency updates =========================== * Iris is now using the latest version release of Dask (currently 0.19.3) -* +* Proj4 has been temporarily pinned to version < 5 while problems with the + Mollweide projection are addressed. Bugs Fixed ========== From a23674719a785718cebaee6e215d2f6f7f98f717 Mon Sep 17 00:00:00 2001 From: Corinne Bosley Date: Wed, 10 Oct 2018 12:16:48 +0100 Subject: [PATCH 3/5] first complete draft of 2.2 whatsnew --- docs/iris/src/whatsnew/2.2.rst | 35 ++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/iris/src/whatsnew/2.2.rst index 217e396c02..3575c1343c 100644 --- a/docs/iris/src/whatsnew/2.2.rst +++ b/docs/iris/src/whatsnew/2.2.rst @@ -51,6 +51,19 @@ Iris 2.2.0 Features * Time mean fields can now be saved to PP files as a cell method. +* Cube aggregators :func:`iris.analysis.MIN`, :func:`iris.analysis.MAX`, + :func:`iris.analysis.SUM` and :func:`iris.analysis.COUNT` now perform lazy + aggregation by utilizing Dask. + +* Error messages thrown upon failed addition of + :class:`iris.aux_factory.AuxCoordFactory` now include the name of the + required (but absent) coordinate as well as the name of the cube. + +* The function :func:`iris.util.find_discontiguities` can be used to check for + discontiguities in the bounds arrays of cube coordinates. Additionally, + discontiguous points in coordinates can be explicitly masked + using another new feature :func:`iris.util.mask_cube`. + Iris 2.1 Dependency updates =========================== @@ -60,12 +73,30 @@ Iris 2.1 Dependency updates * Proj4 has been temporarily pinned to version < 5 while problems with the Mollweide projection are addressed. +* Matplotlib has been pinned to version < 3 temporarily while we account for + its changes in all SciTools libraries. + + Bugs Fixed ========== -* Fixed a bug that prevented printing time coordinates with bounds when the - time coordinate was measured on a long interval (that is, ``months`` +* The bug has been fixed that prevented printing time coordinates with bounds + when the time coordinate was measured on a long interval (that is, ``months`` or ``years``). * "Gracefully filling..." warnings are now only issued when the co-ordinate or bound data is actually masked. + +* Iris can now correctly unpack a column of header objects when saving a + pandas DataFrame to a cube. + + +Documentation Changes +===================== + +* Iris' INSTALL document has been updated to include guidance for running + tests. + +* A link has been added to the Developers' Guide to make it easier to find the + Pull Request Check List. + From 7880acb43b799654cc12fb35a8610b089bf787ea Mon Sep 17 00:00:00 2001 From: Corinne Bosley Date: Wed, 10 Oct 2018 13:46:12 +0100 Subject: [PATCH 4/5] some small corrections --- docs/iris/src/whatsnew/2.2.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/iris/src/whatsnew/2.2.rst index 3575c1343c..b7147b0def 100644 --- a/docs/iris/src/whatsnew/2.2.rst +++ b/docs/iris/src/whatsnew/2.2.rst @@ -1,4 +1,4 @@ -What's New in Iris 2.2.0 +What's New in Iris 2.2 ************************ :Release: 2.2.0 @@ -6,11 +6,11 @@ What's New in Iris 2.2.0 This document explains the new/changed features of Iris in the release -of version 2.2.0 +of version 2.2 (:doc:`View all changes `). -Iris 2.2.0 Features +Iris 2.2 Features =================== .. _showcase: @@ -34,6 +34,11 @@ Iris 2.2.0 Features :func:`iris.analysis.cartography.rotate_grid_vectors` have been added, allowing you to convert gridcell-oriented vectors to true-North/East ones. +.. admonition:: NetCDF Data Variable Chunk Sizes + + NetCDF data variable chunk sizes are now utilised at load time for + significant performance improvements. + * The :class:`iris.fileformats.um.FieldCollation` objects, which are passed into load callbacks when using :func:`iris.fileformats.um.structured_um_loading`, now @@ -43,9 +48,6 @@ Iris 2.2.0 Features These provide the file locations of the original data fields, which are otherwise lost in the structured loading process. -* NetCDF data variable chunk sizes are utilised at load time for significant - performance improvements. - * :func:`iris.util.reverse` can now be used to reverse a cube by specifying one or more coordinates. @@ -65,8 +67,8 @@ Iris 2.2.0 Features using another new feature :func:`iris.util.mask_cube`. -Iris 2.1 Dependency updates -=========================== +Iris 2.2 Dependency updates +============================= * Iris is now using the latest version release of Dask (currently 0.19.3) From 24e9e39b32b7d42d7a97854a88d7f8bc1acc57c6 Mon Sep 17 00:00:00 2001 From: Corinne Bosley Date: Thu, 11 Oct 2018 09:16:54 +0100 Subject: [PATCH 5/5] made corrections suggested in review --- docs/iris/src/whatsnew/2.2.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/iris/src/whatsnew/2.2.rst index b7147b0def..f38bfa1bc3 100644 --- a/docs/iris/src/whatsnew/2.2.rst +++ b/docs/iris/src/whatsnew/2.2.rst @@ -16,7 +16,7 @@ Iris 2.2 Features .. admonition:: 2-Dimensional Coordinate Plotting - The iris plot functions :func:`~iris.plot.pcolor` and + The Iris plot functions :func:`~iris.plot.pcolor` and :func:`~iris.plot.pcolormesh` now accommodate the plotting of 2-dimensional coordinates as well as 1-dimensional coordinates. @@ -25,12 +25,12 @@ Iris 2.2 Features contiguous, or the cube's data must be masked at the discontiguities in order to avoid plotting errors. - The iris plot function :func:`iris.plot.quiver` has been added, and this + The Iris plot function :func:`iris.plot.quiver` has been added, and this also works with 2-dimensional plot coordinates. .. admonition:: 2-Dimensional Grid Vectors - The iris functions :func:`iris.analysis.cartography.gridcell_angles` and + The Iris functions :func:`iris.analysis.cartography.gridcell_angles` and :func:`iris.analysis.cartography.rotate_grid_vectors` have been added, allowing you to convert gridcell-oriented vectors to true-North/East ones. @@ -55,10 +55,10 @@ Iris 2.2 Features * Cube aggregators :func:`iris.analysis.MIN`, :func:`iris.analysis.MAX`, :func:`iris.analysis.SUM` and :func:`iris.analysis.COUNT` now perform lazy - aggregation by utilizing Dask. + aggregation by utilizing dask. -* Error messages thrown upon failed addition of - :class:`iris.aux_factory.AuxCoordFactory` now include the name of the +* Error messages thrown upon failed addition of an + :class:`~iris.aux_factory.AuxCoordFactory` now include the name of the required (but absent) coordinate as well as the name of the cube. * The function :func:`iris.util.find_discontiguities` can be used to check for @@ -70,7 +70,7 @@ Iris 2.2 Features Iris 2.2 Dependency updates ============================= -* Iris is now using the latest version release of Dask (currently 0.19.3) +* Iris is now using the latest version release of dask (currently 0.19.3) * Proj4 has been temporarily pinned to version < 5 while problems with the Mollweide projection are addressed. @@ -86,7 +86,7 @@ Bugs Fixed when the time coordinate was measured on a long interval (that is, ``months`` or ``years``). -* "Gracefully filling..." warnings are now only issued when the co-ordinate or +* "Gracefully filling..." warnings are now only issued when the coordinate or bound data is actually masked. * Iris can now correctly unpack a column of header objects when saving a @@ -96,7 +96,7 @@ Bugs Fixed Documentation Changes ===================== -* Iris' INSTALL document has been updated to include guidance for running +* Iris' `INSTALL` document has been updated to include guidance for running tests. * A link has been added to the Developers' Guide to make it easier to find the