Rename gridadapter.py to xgrid.py

Author: VeckoTheGecko

parcels/field.py

@@ -18,7 +18,6 @@
     VectorType,
     assert_valid_mesh,
 )
-from parcels.gridadapter import XGrid
 from parcels.tools.converters import (
     UnitConverter,
     unitconverters_map,
@@ -32,6 +31,7 @@
 )
 from parcels.uxgrid import UxGrid
 from parcels.xgcm.grid import Grid
+from parcels.xgrid import XGrid
 
 from ._index_search import _search_time_index
 

parcels/gridadapter.py parcels/xgrid.pyparcels/gridadapter.py renamed to parcels/xgrid.py

@@ -37,16 +37,16 @@ class XGrid:
     """
 
     def __init__(self, grid: xgcm.Grid, mesh="flat"):
-        self.grid = grid
+        self.xgcm_grid = grid
         self.mesh = mesh
 
         # ! Not ideal... Triggers computation on a throwaway item. If adapter is still needed in codebase, and this is prohibitively expensive, perhaps store GridAdapter on Field object instead of Grid
         self.lonlat_minmax = np.array(
             [
-                np.nanmin(self.grid._ds["lon"]),
-                np.nanmax(self.grid._ds["lon"]),
-                np.nanmin(self.grid._ds["lat"]),
-                np.nanmax(self.grid._ds["lat"]),
+                np.nanmin(self.xgcm_grid._ds["lon"]),
+                np.nanmax(self.xgcm_grid._ds["lon"]),
+                np.nanmin(self.xgcm_grid._ds["lat"]),
+                np.nanmax(self.xgcm_grid._ds["lat"]),
             ]
         )
 
@@ -59,10 +59,10 @@ def lon(self):
         TODO v4: Evaluate
         """
         try:
-            _ = self.grid.axes["X"]
+            _ = self.xgcm_grid.axes["X"]
         except KeyError:
             return np.zeros(1)
-        return self.grid._ds["lon"].values
+        return self.xgcm_grid._ds["lon"].values
 
     @property
     def lat(self):
@@ -73,10 +73,10 @@ def lat(self):
         TODO v4: Evaluate
         """
         try:
-            _ = self.grid.axes["Y"]
+            _ = self.xgcm_grid.axes["Y"]
         except KeyError:
             return np.zeros(1)
-        return self.grid._ds["lat"].values
+        return self.xgcm_grid._ds["lat"].values
 
     @property
     def depth(self):
@@ -87,15 +87,15 @@ def depth(self):
         TODO v4: Evaluate
         """
         try:
-            _ = self.grid.axes["Z"]
+            _ = self.xgcm_grid.axes["Z"]
         except KeyError:
             return np.zeros(1)
-        return self.grid._ds["depth"].values
+        return self.xgcm_grid._ds["depth"].values
 
     @property
     def _datetimes(self):
         try:
-            axis = self.grid.axes["T"]
+            axis = self.xgcm_grid.axes["T"]
         except KeyError:
             return np.zeros(1)
         return get_time(axis)
@@ -106,19 +106,19 @@ def time(self):
 
     @property
     def xdim(self):
-        return get_dimensionality(self.grid.axes.get("X"))
+        return get_dimensionality(self.xgcm_grid.axes.get("X"))
 
     @property
     def ydim(self):
-        return get_dimensionality(self.grid.axes.get("Y"))
+        return get_dimensionality(self.xgcm_grid.axes.get("Y"))
 
     @property
     def zdim(self):
-        return get_dimensionality(self.grid.axes.get("Z"))
+        return get_dimensionality(self.xgcm_grid.axes.get("Z"))
 
     @property
     def tdim(self):
-        return get_dimensionality(self.grid.axes.get("T"))
+        return get_dimensionality(self.xgcm_grid.axes.get("T"))
 
     @property
     def time_origin(self):

tests/v4/test_gridadapter.py tests/v4/test_xgrid.pytests/v4/test_gridadapter.py renamed to tests/v4/test_xgrid.py

@@ -7,8 +7,8 @@
 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 XGrid
 from parcels.tools.converters import TimeConverter
+from parcels.xgrid import XGrid
 
 GridTestCase = namedtuple("GridTestCase", ["Grid", "attr", "expected"])
 
@@ -38,7 +38,7 @@ def assert_equal(actual, expected):
 
 
 @pytest.mark.parametrize("ds, attr, expected", test_cases)
-def test_grid_adapter_properties_ground_truth(ds, attr, expected):
+def test_xgrid_properties_ground_truth(ds, attr, expected):
     adapter = XGrid(xgcm.Grid(ds, periodic=False))
     actual = getattr(adapter, attr)
     assert_equal(actual, expected)
@@ -60,7 +60,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):
+def test_xgrid_against_old(ds, attr):
     adapter = XGrid(xgcm.Grid(ds, periodic=False))
 
     grid = OldGrid.create_grid(