Rename GridAdapter to XGrid

This class now attaches Parcels specific functionality and methods to the original xgcm Grid

Author: VeckoTheGecko

parcels/field.py

@@ -18,7 +18,7 @@
     VectorType,
     assert_valid_mesh,
 )
-from parcels.gridadapter import GridAdapter
+from parcels.gridadapter import XGrid
 from parcels.tools.converters import (
     UnitConverter,
     unitconverters_map,
@@ -177,7 +177,7 @@ def __init__(
         # For compatibility with parts of the codebase that rely on v3 definition of Grid.
         # Should be worked to be removed in v4
         if isinstance(grid, Grid):
-            self.gridadapter = GridAdapter(grid)
+            self.gridadapter = XGrid(grid)
         else:
             self.gridadapter = None
 

parcels/gridadapter.py

@@ -29,7 +29,13 @@ def get_time(axis: xgcm.Axis) -> npt.NDArray:
     return axis._ds[axis.coords["center"]].values
 
 
-class GridAdapter:
+class XGrid:
+    """
+    Class to represent a structured grid in Parcels. Wraps a xgcm-like Grid object (we use a trimmed down version of the xgcm.Grid class that is vendored with Parcels).
+
+    This class provides methods and properties required for indexing and interpolating on the grid.
+    """
+
     def __init__(self, grid: xgcm.Grid, mesh="flat"):
         self.grid = grid
         self.mesh = mesh

tests/v4/test_gridadapter.py

@@ -7,7 +7,7 @@
 from parcels import xgcm
 from parcels._datasets.structured.generic import T, X, Y, Z, datasets
 from parcels.grid import Grid as OldGrid
-from parcels.gridadapter import GridAdapter
+from parcels.gridadapter import XGrid
 from parcels.tools.converters import TimeConverter
 
 GridTestCase = namedtuple("GridTestCase", ["Grid", "attr", "expected"])
@@ -39,7 +39,7 @@ def assert_equal(actual, expected):
 
 @pytest.mark.parametrize("ds, attr, expected", test_cases)
 def test_grid_adapter_properties_ground_truth(ds, attr, expected):
-    adapter = GridAdapter(xgcm.Grid(ds, periodic=False))
+    adapter = XGrid(xgcm.Grid(ds, periodic=False))
     actual = getattr(adapter, attr)
     assert_equal(actual, expected)
 
@@ -61,7 +61,7 @@ def test_grid_adapter_properties_ground_truth(ds, attr, expected):
 )
 @pytest.mark.parametrize("ds", datasets.values())
 def test_grid_adapter_against_old(ds, attr):
-    adapter = GridAdapter(xgcm.Grid(ds, periodic=False))
+    adapter = XGrid(xgcm.Grid(ds, periodic=False))
 
     grid = OldGrid.create_grid(
         lon=ds.lon.values,