Merge remote-tracking branch 'origin/rajeeja/yac' into rajeeja/yac

rajeeja · rajeeja · commit 4bcbf77f9c94 · 2026-04-02T16:09:27.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,6 +11,8 @@ jobs:
     #   github.repository == 'UXARRAY/uxarray'
     name: Python (${{ matrix.python-version }}, ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
+    env:
+      MPLBACKEND: Agg
     defaults:
       run:
         shell: bash -l {0}
diff --git a/.github/workflows/yac-optional.yml b/.github/workflows/yac-optional.yml
@@ -10,14 +10,14 @@ on:
 
 jobs:
   yac-optional:
-    name: YAC v3.9.3 (Ubuntu)
+    name: YAC core v3.14.0_p1 (Ubuntu)
     runs-on: ubuntu-latest
     defaults:
       run:
         shell: bash -l {0}
     env:
-      YAC_VERSION: v3.9.3
-      YAXT_VERSION: v0.11.5
+      YAC_VERSION: v3.14.0_p1
+      YAXT_VERSION: v0.11.5.1
       MPIEXEC: /usr/bin/mpirun
       MPIRUN: /usr/bin/mpirun
       MPICC: /usr/bin/mpicc
@@ -50,8 +50,6 @@ jobs:
             automake \
             gawk \
             gfortran \
-            libfyaml-dev \
-            libnetcdf-dev \
             libopenmpi-dev \
             libtool \
             make \
@@ -68,7 +66,7 @@ jobs:
       - name: Install Python build dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install cython mpi4py wheel
+          python -m pip install cython wheel
       - name: Build and install YAXT
         run: |
           set -euxo pipefail
@@ -107,9 +105,11 @@ jobs:
           ../configure \
             --prefix="${YAC_PREFIX}" \
             --with-yaxt-root="${YAC_PREFIX}" \
-            --with-netcdf-root="${CONDA_PREFIX}" \
-            --with-fyaml-root=/usr \
-            --without-regard-for-quality \
+            --disable-mci \
+            --disable-utils \
+            --disable-examples \
+            --disable-tools \
+            --disable-netcdf \
             --enable-python-bindings \
             CC="${MPICC}" \
             FC="${MPIF90}"
@@ -121,11 +121,18 @@ jobs:
           PY_VER="$(python -c 'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")')"
           echo "LD_LIBRARY_PATH=${YAC_PREFIX}/lib:${LD_LIBRARY_PATH:-}" >> "${GITHUB_ENV}"
           echo "PYTHONPATH=${YAC_PREFIX}/lib/python${PY_VER}/site-packages:${YAC_PREFIX}/lib/python${PY_VER}/dist-packages:${PYTHONPATH:-}" >> "${GITHUB_ENV}"
-      - name: Verify YAC Python bindings
+      - name: Verify YAC core Python bindings
         run: |
           python - <<'PY'
-          import yac
-          print("YAC version:", getattr(yac, "__version__", "unknown"))
+          from pathlib import Path
+          import sys
+          candidates = []
+          for entry in sys.path:
+              pkg = Path(entry) / "yac"
+              candidates.extend(pkg.glob("core*.so"))
+              candidates.extend(pkg.glob("core*.pyd"))
+          assert candidates, "yac.core extension not found on sys.path"
+          print("Found yac.core extension:", candidates[0])
           PY
       - name: Install uxarray
         run: |
diff --git a/test/test_remap_yac.py b/test/test_remap_yac.py
@@ -2,9 +2,13 @@
 import pytest
 
 import uxarray as ux
+from uxarray.remap.yac import YacNotAvailableError, _import_yac
 
 
-yac = pytest.importorskip("yac")
+try:
+    _import_yac()
+except YacNotAvailableError:
+    pytest.skip("yac.core is not available", allow_module_level=True)
 
 
 def test_yac_nnn_node_remap(gridpath, datasetpath):
@@ -28,7 +32,7 @@ def test_yac_conservative_face_remap(gridpath):
     uxds = ux.open_dataset(mesh_path, mesh_path)
     dest = ux.open_grid(mesh_path)
 
-    out = uxds["latCell"].remap.nearest_neighbor(
+    out = uxds["latCell"].remap(
         destination_grid=dest,
         remap_to="faces",
         backend="yac",
@@ -62,3 +66,179 @@ def test_yac_matches_uxarray_nearest_neighbor():
     )
     assert ux_out.shape == yac_out.shape
     assert (ux_out.values == yac_out.values).all()
+
+
+def test_yac_call_defaults_to_nnn():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([1.0, 2.0, 3.0]),
+        dims=["n_node"],
+        coords={"n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+
+    out = da.remap(
+        destination_grid=grid,
+        remap_to="nodes",
+        backend="yac",
+    )
+
+    assert out.shape == da.shape
+    np.testing.assert_array_equal(out.values, da.values)
+
+
+def test_yac_invalid_backend_raises():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([1.0, 2.0, 3.0]),
+        dims=["n_node"],
+        coords={"n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+
+    with pytest.raises(ValueError, match="Invalid backend"):
+        da.remap.nearest_neighbor(
+            destination_grid=grid,
+            remap_to="nodes",
+            backend="bogus",
+        )
+
+
+def test_yac_idw_not_implemented():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([1.0, 2.0, 3.0]),
+        dims=["n_node"],
+        coords={"n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+
+    with pytest.raises(NotImplementedError, match="inverse_distance_weighted"):
+        da.remap.inverse_distance_weighted(
+            destination_grid=grid,
+            remap_to="nodes",
+            backend="yac",
+            yac_method="nnn",
+            yac_options={"n": 1},
+        )
+
+
+def test_yac_bilinear_face_remap(gridpath):
+    mesh_path = gridpath("mpas", "QU", "mesh.QU.1920km.151026.nc")
+    uxds = ux.open_dataset(mesh_path, mesh_path)
+    dest = ux.open_grid(mesh_path)
+
+    out = uxds["latCell"].remap.bilinear(
+        destination_grid=dest,
+        remap_to="faces",
+        backend="yac",
+    )
+
+    assert out.size == dest.n_face
+
+
+def test_yac_conservative_rejects_non_face_data():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([1.0, 2.0, 3.0]),
+        dims=["n_node"],
+        coords={"n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+
+    with pytest.raises(ValueError, match="face-centered"):
+        da.remap.nearest_neighbor(
+            destination_grid=grid,
+            remap_to="nodes",
+            backend="yac",
+            yac_method="conservative",
+            yac_options={"order": 1},
+        )
+
+
+def test_yac_preserves_spatial_coordinate_remap():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([1.0, 2.0, 3.0]),
+        dims=["n_node"],
+        coords={
+            "n_node": [0, 1, 2],
+            "node_lon": (
+                "n_node",
+                np.array([0.0, -180.0, 0.0]),
+                {"standard_name": "longitude", "units": "degrees_east"},
+            ),
+            "node_lat": (
+                "n_node",
+                np.array([90.0, 0.0, -90.0]),
+                {"standard_name": "latitude", "units": "degrees_north"},
+            ),
+        },
+        uxgrid=grid,
+    )
+
+    out = da.remap.nearest_neighbor(
+        destination_grid=grid,
+        remap_to="nodes",
+        backend="yac",
+        yac_method="nnn",
+        yac_options={"n": 1},
+    )
+
+    np.testing.assert_array_equal(out.values, da.values)
+    assert "node_lon" in out.coords
+    assert "node_lat" in out.coords
+
+
+def test_yac_batched_remap_with_extra_dimension():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([[1.0, 2.0, 3.0], [10.0, 20.0, 30.0]]),
+        dims=["time", "n_node"],
+        coords={"time": [0, 1], "n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+
+    out = da.remap.nearest_neighbor(
+        destination_grid=grid,
+        remap_to="nodes",
+        backend="yac",
+        yac_method="nnn",
+        yac_options={"n": 1},
+    )
+
+    assert out.shape == da.shape
+    np.testing.assert_array_equal(out.values, da.values)
+
+
+def test_yac_batched_remap_with_fractional_mask():
+    verts = np.array([(0.0, 90.0), (-180.0, 0.0), (0.0, -90.0)])
+    grid = ux.open_grid(verts)
+    da = ux.UxDataArray(
+        np.asarray([[1.0, 2.0, 3.0], [10.0, 20.0, 30.0]]),
+        dims=["time", "n_node"],
+        coords={"time": [0, 1], "n_node": [0, 1, 2]},
+        uxgrid=grid,
+    )
+    frac_mask = np.ones_like(da.values, dtype=np.float64)
+
+    out = da.remap.nearest_neighbor(
+        destination_grid=grid,
+        remap_to="nodes",
+        backend="yac",
+        yac_method="nnn",
+        yac_options={
+            "n": 1,
+            "frac_mask_fallback_value": 0.0,
+            "frac_mask": frac_mask,
+        },
+    )
+
+    assert out.shape == da.shape
+    np.testing.assert_array_equal(out.values, da.values)
diff --git a/uxarray/remap/accessor.py b/uxarray/remap/accessor.py
@@ -11,6 +11,15 @@
 from uxarray.remap.inverse_distance_weighted import _inverse_distance_weighted_remap
 from uxarray.remap.nearest_neighbor import _nearest_neighbor_remap
 
+_VALID_BACKENDS = ("uxarray", "yac")
+
+
+def _validate_backend(backend: str) -> None:
+    if backend not in _VALID_BACKENDS:
+        raise ValueError(
+            f"Invalid backend '{backend}'. Expected one of {_VALID_BACKENDS}."
+        )
+
 
 class RemapAccessor:
     """Expose remapping methods on UxDataArray and UxDataset objects."""
@@ -41,13 +50,10 @@ def __call__(
         Calling `.remap(...)` with no explicit method will invoke
         `nearest_neighbor(...)`.
         """
-        return self.nearest_neighbor(
-            *args,
-            backend=backend,
-            yac_method=yac_method,
-            yac_options=yac_options,
-            **kwargs,
-        )
+        nn_kwargs: dict = {"backend": backend, "yac_options": yac_options}
+        if yac_method is not None:
+            nn_kwargs["yac_method"] = yac_method
+        return self.nearest_neighbor(*args, **nn_kwargs, **kwargs)
 
     def nearest_neighbor(
         self,
@@ -84,6 +90,7 @@ def nearest_neighbor(
             A new object with data mapped onto `destination_grid`.
         """
 
+        _validate_backend(backend)
         if backend == "yac":
             from uxarray.remap.yac import _yac_remap
 
@@ -136,12 +143,14 @@ def inverse_distance_weighted(
             A new object with data mapped onto `destination_grid`.
         """
 
+        _validate_backend(backend)
         if backend == "yac":
-            from uxarray.remap.yac import _yac_remap
-
-            yac_kwargs = yac_options or {}
-            return _yac_remap(
-                self.ux_obj, destination_grid, remap_to, yac_method, yac_kwargs
+            raise NotImplementedError(
+                "inverse_distance_weighted with backend='yac' is not implemented. "
+                "The YAC backend currently supports only 'nnn' and 'conservative' "
+                "methods and will not perform inverse-distance-weighted remapping. "
+                "Use backend='uxarray' for IDW, or choose a different remapping "
+                "method that is supported by YAC."
             )
         return _inverse_distance_weighted_remap(
             self.ux_obj, destination_grid, remap_to, power, k
@@ -152,7 +161,6 @@ def bilinear(
         destination_grid: Grid,
         remap_to: str = "faces",
         backend: str = "uxarray",
-        yac_method: str | None = None,
         yac_options: dict | None = None,
         **kwargs,
     ) -> UxDataArray | UxDataset:
@@ -167,24 +175,23 @@ def bilinear(
             Which grid element receives the remapped values.
 
         backend : {'uxarray', 'yac'}, default='uxarray'
-            Remapping backend to use. When set to 'yac', requires YAC to be
-            available on PYTHONPATH.
-        yac_method : {'nnn', 'conservative'}, optional
-            YAC interpolation method. Required when backend='yac'.
+            Remapping backend to use. When set to 'yac', bilinear remapping is
+            routed through YAC's average interpolation.
         yac_options : dict, optional
-            YAC interpolation configuration options.
+            YAC interpolation configuration options for the average method.
 
         Returns
         -------
         UxDataArray or UxDataset
             A new object with data mapped onto `destination_grid`.
         """
 
+        _validate_backend(backend)
         if backend == "yac":
             from uxarray.remap.yac import _yac_remap
 
             yac_kwargs = yac_options or {}
             return _yac_remap(
-                self.ux_obj, destination_grid, remap_to, yac_method, yac_kwargs
+                self.ux_obj, destination_grid, remap_to, "average", yac_kwargs
             )
         return _bilinear(self.ux_obj, destination_grid, remap_to)
diff --git a/uxarray/remap/yac.py b/uxarray/remap/yac.py
