From 4fd59677994fdeab5d9b77406189fa3362e14bda Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 28 Jan 2022 09:28:46 +0000 Subject: [PATCH 1/2] Deprecated experimental regrid_conservative. --- lib/iris/experimental/regrid_conservative.py | 40 ++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/lib/iris/experimental/regrid_conservative.py b/lib/iris/experimental/regrid_conservative.py index 421bd86c93..d2bfe3608b 100644 --- a/lib/iris/experimental/regrid_conservative.py +++ b/lib/iris/experimental/regrid_conservative.py @@ -6,16 +6,33 @@ """ Support for conservative regridding via ESMPy. +.. note:: + + .. deprecated:: 3.2.0 + + This package will be removed in a future release. + Please use `iris-esmf-regrid`_ instead. + """ import cartopy.crs as ccrs import numpy as np import iris +from iris._deprecation import warn_deprecated from iris.analysis._interpolation import get_xy_dim_coords from iris.analysis._regrid import RectilinearRegridder from iris.util import _meshgrid +wmsg = ( + "The 'iris.experimental.regrid_conservative' package is deprecated since " + "version 3.2, and will be removed in a future release. Please use " + "iris-emsf-regrid instead. " + "See https://github.com/SciTools-incubator/iris-esmf-regrid." +) +warn_deprecated(wmsg) + + #: A static Cartopy Geodetic() instance for transforming to true-lat-lons. _CRS_TRUELATLON = ccrs.Geodetic() @@ -131,6 +148,20 @@ def regrid_conservative_via_esmpy(source_cube, grid_cube): """ Perform a conservative regridding with ESMPy. + .. note :: + + .. deprecated:: 3.2.0 + + This function is scheduled to be removed in a future release. + Please use `iris-esmf-regrid`_ instead. + + For example : + + .. code:: + + from emsf_regrid.schemes import ESMFAreaWeighted + result = src_cube.regrid(grid_cube, ESMFAreaWeighted()) + Regrids the data of a source cube onto a new grid defined by a destination cube. @@ -169,6 +200,15 @@ def regrid_conservative_via_esmpy(source_cube, grid_cube): To alter this, make a prior call to ESMF.Manager(). """ + wmsg = ( + "The function " + "'iris.experimental.regrid_conservative." + "regrid_weighted_curvilinear_to_rectilinear' " + "has been deprecated, and will be removed in a future release. " + "Please consult the docstring for details." + ) + warn_deprecated(wmsg) + # Lazy import so we can build the docs with no ESMF. import ESMF From e43a68da65d1d0dfa75b0435e79c24f47f2a80f7 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 28 Jan 2022 09:44:35 +0000 Subject: [PATCH 2/2] Fix link. --- lib/iris/experimental/regrid_conservative.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/iris/experimental/regrid_conservative.py b/lib/iris/experimental/regrid_conservative.py index d2bfe3608b..bfa048ddf0 100644 --- a/lib/iris/experimental/regrid_conservative.py +++ b/lib/iris/experimental/regrid_conservative.py @@ -11,7 +11,9 @@ .. deprecated:: 3.2.0 This package will be removed in a future release. - Please use `iris-esmf-regrid`_ instead. + Please use + `iris-esmf-regrid `_ + instead. """ @@ -153,7 +155,9 @@ def regrid_conservative_via_esmpy(source_cube, grid_cube): .. deprecated:: 3.2.0 This function is scheduled to be removed in a future release. - Please use `iris-esmf-regrid`_ instead. + Please use + `iris-esmf-regrid `_ + instead. For example :