add documentation

SciTools · Aug 30, 2023 · a48b9a0 · a48b9a0
1 parent 6ec217c
commit a48b9a0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+- [PR#276](https://github.com/SciTools-incubator/iris-esmf-regrid/pull/276)
+  Allow regridding for grids defined on coordinates without bounds for
+  nearest neighbour and bilinear methods.
+  [@stephenworsley](https://github.com/stephenworsley)
+
 ### Fixed
 
 - [PR#301](https://github.com/SciTools-incubator/iris-esmf-regrid/pull/301)

diff --git a/esmf_regrid/schemes.py b/esmf_regrid/schemes.py
@@ -914,9 +914,13 @@ def regridder(
         ----------
         src_grid : :class:`iris.cube.Cube`
             The :class:`~iris.cube.Cube` defining the source.
+            If this cube has a grid defined by latitude/longitude coordinates, those
+            coordinates must have bounds.
         tgt_grid : :class:`iris.cube.Cube` or :class:`iris.experimental.ugrid.Mesh`
             The unstructured :class:`~iris.cube.Cube`or
             :class:`~iris.experimental.ugrid.Mesh` defining the target.
+            If this cube has a grid defined by latitude/longitude coordinates, those
+            coordinates must have bounds.
         use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, optional
             Array describing which elements :mod:`esmpy` will ignore on the src_grid.
             If True, the mask will be derived from src_grid.
@@ -1373,9 +1377,13 @@ def __init__(
         ----------
         src : :class:`iris.cube.Cube`
             The rectilinear :class:`~iris.cube.Cube` providing the source.
+            If this cube has a grid defined by latitude/longitude coordinates, those
+            coordinates must have bounds.
         tgt : :class:`iris.cube.Cube` or :class:`iris.experimental.ugrid.Mesh`
             The unstructured :class:`~iris.cube.Cube`or
             :class:`~iris.experimental.ugrid.Mesh` defining the target.
+            If this cube has a grid defined by latitude/longitude coordinates, those
+            coordinates must have bounds.
         mdtol : float, default=0
             Tolerance of missing data. The value returned in each element of
             the returned array will be masked if the fraction of masked data