diff --git a/docs/src/userguide/subsetting_a_cube.rst b/docs/src/userguide/subsetting_a_cube.rst index e644373050..27a223042e 100644 --- a/docs/src/userguide/subsetting_a_cube.rst +++ b/docs/src/userguide/subsetting_a_cube.rst @@ -333,7 +333,7 @@ after 1st January 2008. Cube Masking -------------- - +.. _masking-from-shapefile: Masking from a shapefile ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -353,7 +353,7 @@ the :class:`iris.util.mask_cube_from_shapefile` function. Once plotted, we can s .. plot:: userguide/plotting_examples/masking_brazil_plot.py :include-source: -We can see that the dimensions of the cube haven't changed - the plot is still global. But only the data over Brazil is plotted - the rest is masked. +We can see that the dimensions of the cube haven't changed - the plot is still global. But only the data over Brazil is plotted - the rest is masked. .. note:: While Iris will try to dynamically adjust the shapefile to mask cubes of different projections, it can struggle with rotated pole projections and cubes with Meridians not at 0° diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index e711679a7f..7184f91173 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -67,6 +67,12 @@ This document explains the changes made to Iris for this release NetCDF chunking with the use of the :data:`iris.fileformats.netcdf.loader.CHUNK_CONTROL` context manager. (:pull:`5588`) +#. `@acchamber`_ and `@trexfeathers`_ (reviewer) added + :func:`iris.util.mask_cube_from_shapefile`. This builds on the original work + of `@ckmo`_, `@david-bentley`_, `@jmendesmetoffice`_, `@evyve`_ and + `@pelson`_ for the UK Met Office **ASCEND** library. See + :ref:`masking-from-shapefile` for documentation. (:pull:`5470`) + 🐛 Bugs Fixed ============= @@ -107,7 +113,7 @@ This document explains the changes made to Iris for this release #. `@bouweandela`_ changed :func:`iris.coords.Coord.cell` so it does not realize all coordinate data and only loads a single cell instead. (:pull:`5693`) -#. `@rcomer`_ and `@trexfeathers`_ (reviewer) modified +#. `@rcomer`_ and `@trexfeathers`_ (reviewer) modified :func:`~iris.analysis.stats.pearsonr` so it preserves lazy data in all cases and also runs a little faster. (:pull:`5638`) @@ -229,6 +235,10 @@ This document explains the changes made to Iris for this release .. _@scottrobinson02: https://github.com/scottrobinson02 .. _@acchamber: https://github.com/acchamber .. _@fazledyn-or: https://github.com/fazledyn-or +.. _@ckmo: https://github.com/ckmo +.. _@david-bentley: https://github.com/david-bentley +.. _@jmendesmetoffice: https://github.com/jmendesmetoffice +.. _@evyve: https://github.com/evyve .. comment