Add keyword arguments to interp_like instead of kwargs.

Author: ecomodeller

mikeio/dataset/_dataarray.py

@@ -1232,29 +1232,42 @@ def interp_na(self, axis: str = "time", **kwargs: Any) -> "DataArray":
 
     def interp_like(
         self,
-        other: "DataArray" | Grid2D | GeometryFM2D | pd.DatetimeIndex,
+        other: "DataArray" | Grid2D | GeometryFM2D,
+        *,
+        extrapolate: bool = True,
+        n_nearest: int = 3,
+        p: int = 2,
+        radius: float | None = None,
         interpolant: tuple[Any, Any] | None = None,
         **kwargs: Any,
     ) -> "DataArray":
-        """Interpolate in space (and in time) to other geometry (and time axis).
+        """Interpolate in space to other geometry.
 
         Note: currently only supports interpolation from dfsu-2d to
               dfs2 or other dfsu-2d DataArrays
 
         Parameters
         ----------
-        other: Dataset, DataArray, Grid2D, GeometryFM, pd.DatetimeIndex
+        other: Dataset, DataArray, Grid2D, GeometryFM
             The target geometry (and time axis) to interpolate to
+        n_nearest: int, optional
+            Number of nearest elements to use for interpolation
+        extrapolate: bool, optional
+            allow extrapolation, by default False
+        p: int, optional
+            power of inverse distance weighting, default=2
+        radius: float, optional
+            an alternative to extrapolate=False,
+            only include elements within radius
         interpolant: tuple, optional
             Reuse pre-calculated index and weights
         **kwargs: Any
-            additional kwargs are passed to interpolation method
+            deprecated, use interp_time instead
 
         Examples
         --------
         >>> dai = da.interp_like(da2)
         >>> dae = da.interp_like(da2, extrapolate=True)
-        >>> dat = da.interp_like(da2.time)
 
         Returns
         -------
@@ -1268,6 +1281,10 @@ def interp_like(
             )
 
         if isinstance(other, pd.DatetimeIndex):
+            warnings.warn(
+                "Interpolation to a new time axis will not longer be supported by interp_like, use interp_time instead.",
+                FutureWarning,
+            )
             return self.interp_time(other, **kwargs)
 
         if not (isinstance(self.geometry, GeometryFM2D) and self.geometry.is_2d):
@@ -1290,7 +1307,9 @@ def interp_like(
             raise NotImplementedError()
 
         if interpolant is None:
-            elem_ids, weights = self.geometry.get_2d_interpolant(xy, **kwargs)
+            elem_ids, weights = self.geometry.get_2d_interpolant(
+                xy, n_nearest=n_nearest, extrapolate=extrapolate, p=p, radius=radius
+            )
         else:
             elem_ids, weights = interpolant
 

mikeio/dataset/_dataset.py

@@ -1159,19 +1159,33 @@ def interp_na(self, axis: str = "time", **kwargs: Any) -> "Dataset":
     def interp_like(
         self,
         other: "Dataset" | DataArray | Grid2D | GeometryFM2D | pd.DatetimeIndex,
+        *,
+        extrapolate: bool = True,
+        n_nearest: int = 3,
+        p: int = 2,
+        radius: float | None = None,
         **kwargs: Any,
     ) -> "Dataset":
-        """Interpolate in space (and in time) to other geometry (and time axis).
+        """Interpolate in space to other geometry.
 
         Note: currently only supports interpolation from dfsu-2d to
               dfs2 or other dfsu-2d Datasets
 
         Parameters
         ----------
-        other: Dataset, DataArray, Grid2D, GeometryFM, pd.DatetimeIndex
+        other: Dataset, DataArray, Grid2D, GeometryFM
             Dataset, DataArray, Grid2D or GeometryFM2D to interpolate to
+        n_nearest: int, optional
+            Number of nearest elements to use for interpolation
+        extrapolate: bool, optional
+            allow extrapolation, by default False
+        p: int, optional
+            power of inverse distance weighting, default=2
+        radius: float, optional
+            an alternative to extrapolate=False,
+            only include elements within radius
         **kwargs: Any
-            additional kwargs are passed to interpolation method
+            deprecated, use interp_time instead
 
         Examples
         --------
@@ -1180,7 +1194,6 @@ def interp_like(
         >>> dsi = ds.interp_like(ds2)
         >>> dsi.to_dfs("HD_gridded.dfs2")
         >>> dse = ds.interp_like(ds2, extrapolate=True)
-        >>> dst = ds.interp_like(ds2.time)
 
         Returns
         -------
@@ -1194,6 +1207,10 @@ def interp_like(
             )
 
         if isinstance(other, pd.DatetimeIndex):
+            warnings.warn(
+                "Interpolation to a new time axis will not longer be supported by interp_like, use interp_time instead.",
+                FutureWarning,
+            )
             return self.interp_time(other, **kwargs)
 
         if hasattr(other, "geometry"):
@@ -1213,7 +1230,9 @@ def interp_like(
         else:
             raise NotImplementedError()
 
-        interpolant = self.geometry.get_2d_interpolant(xy, **kwargs)
+        interpolant = self.geometry.get_2d_interpolant(
+            xy, n_nearest=n_nearest, extrapolate=extrapolate, p=p, radius=radius
+        )
         das = [da.interp_like(geom, interpolant=interpolant) for da in self]
         ds = Dataset(das, validate=False)
 

pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "PyYAML",
     "tqdm",
     "xarray",
+    "pre-commit>=4.1.0",
 ]
 
 authors = [

tests/test_dataarray.py

@@ -799,9 +799,10 @@ def test_interp_time(da1):
     assert dai.timestep == 1800
 
 
-def test_interp_like_index(da1):
+def test_interp_like_index_deprecated(da1):
     da = mikeio.read("tests/testdata/HD2D.dfsu")[0]
-    dai = da.interp_like(da.time)
+    with pytest.warns(FutureWarning):
+        dai = da.interp_like(da.time)
     assert any(dai.time == da.time)