Skip to content

Commit d2f5052

Browse files
authored
Merge a5ff532 into af100e4
2 parents af100e4 + a5ff532 commit d2f5052

19 files changed

+2067
-686
lines changed

docs/src/whatsnew/latest.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ This document explains the changes made to Iris for this release
3434
horizontal grid.
3535
(:issue:`5770`, :pull:`6581`)
3636

37+
#. `@hsteptoe`_ and `@trexfeathers`_ (reviewer) added :func:`iris.util.mask_cube_from_shape`
38+
to handle additional Point and Line shape types. This change also facilitates the use of
39+
shapefiles that use a different projection system to the cube that they are being applied to,
40+
and makes performance improvements to the mask weighting calculations.
41+
(:issue:`6126`, :pull:`6129`).
42+
3743
#. `@bjlittle`_ extended ``zlib`` compression of :class:`~iris.cube.Cube` data
3844
payload when saving to NetCDF to also include any attached `CF-UGRID`_
3945
:class:`~iris.mesh.components.MeshXY`. Additionally,
@@ -75,7 +81,12 @@ This document explains the changes made to Iris for this release
7581
💣 Incompatible Changes
7682
=======================
7783

78-
#. N/A
84+
#. Existing users of :func:`iris.util.mask_cube_from_shapefile` will need to
85+
install the additional dependencies `rasterio`_ and `affine`_ to continue
86+
using this function. These dependencies are necessary to support bug fixes
87+
implemented in (:issue:`6126`, :pull:`6129`). Note that this function will
88+
be deprecated in a future version of Iris in favour of the new
89+
:func:`iris.util.mask_cube_from_shape`, which offers richer shape handling.
7990

8091

8192
🚀 Performance
@@ -110,15 +121,20 @@ This document explains the changes made to Iris for this release
110121
🔗 Dependencies
111122
===============
112123

113-
#. N/A
114-
124+
#. `@hsteptoe`_ added `rasterio`_ and `affine`_ as optional dependencies that facilitate
125+
:func:`iris.util.mask_cube_from_shape`. These packages support new functionality that
126+
handles additional shapefile types and projections. (:issue:`6126`, :pull:`6129`)
115127

116128
📚 Documentation
117129
================
118130

119131
#. `@rcomer`_ updated all Cartopy references to point to the new location at
120132
https://cartopy.readthedocs.io (:pull:`6636`)
121133

134+
#. `@hsteptoe`_ added additional worked examples to the :func:`iris.util.mask_cube_from_shape`
135+
documentation, to demonstrate how to use the function with different types of shapefiles.
136+
(:pull:`6129`)
137+
122138

123139
💼 Internal
124140
===========
@@ -142,11 +158,14 @@ This document explains the changes made to Iris for this release
142158
Whatsnew author names (@github name) in alphabetical order. Note that,
143159
core dev names are automatically included by the common_links.inc:
144160
161+
.. _@hsteptoe: https://github.com/hsteptoe
145162
.. _@melissaKG: https://github.com/melissaKG
146163

147164

148165

149166
.. comment
150167
Whatsnew resources in alphabetical order:
151168
169+
.. _affine: https://affine.readthedocs.io/en/latest/
152170
.. _netcdf-c#3183: https://github.com/Unidata/netcdf-c/issues/3183
171+
.. _rasterio: https://rasterio.readthedocs.io/en/stable/index.html

0 commit comments

Comments
 (0)