Moving simepl_UV_dataset to generated.py

As suggested by @VeckoTheGecko

Author: erikvansebille

parcels/_datasets/structured/generated.py

@@ -0,0 +1,20 @@
+import numpy as np
+import xarray as xr
+
+
+def simple_UV_dataset(dims=(360, 2, 30, 4), maxdepth=1, mesh_type="spherical"):
+    max_lon = 180.0 if mesh_type == "spherical" else 1e6
+
+    return xr.Dataset(
+        {"U": (["time", "depth", "YG", "XG"], np.zeros(dims)), "V": (["time", "depth", "YG", "XG"], np.zeros(dims))},
+        coords={
+            "time": (["time"], xr.date_range("2000", "2001", dims[0]), {"axis": "T"}),
+            "depth": (["depth"], np.linspace(0, maxdepth, dims[1]), {"axis": "Z"}),
+            "YC": (["YC"], np.arange(dims[2]) + 0.5, {"axis": "Y"}),
+            "YG": (["YG"], np.arange(dims[2]), {"axis": "Y", "c_grid_axis_shift": -0.5}),
+            "XC": (["XC"], np.arange(dims[3]) + 0.5, {"axis": "X"}),
+            "XG": (["XG"], np.arange(dims[3]), {"axis": "X", "c_grid_axis_shift": -0.5}),
+            "lat": (["YG"], np.linspace(-90, 90, dims[2]), {"axis": "Y", "c_grid_axis_shift": 0.5}),
+            "lon": (["XG"], np.linspace(-max_lon, max_lon, dims[3]), {"axis": "X", "c_grid_axis_shift": -0.5}),
+        },
+    )

parcels/_datasets/structured/generic.py

@@ -134,24 +134,6 @@ def _unrolled_cone_curvilinear_grid():
     )
 
 
-def simple_UV_dataset(dims=(360, 2, 30, 4), maxdepth=1, mesh_type="spherical"):
-    max_lon = 180.0 if mesh_type == "spherical" else 1e6
-
-    return xr.Dataset(
-        {"U": (["time", "depth", "YG", "XG"], np.zeros(dims)), "V": (["time", "depth", "YG", "XG"], np.zeros(dims))},
-        coords={
-            "time": (["time"], xr.date_range("2000", "2001", dims[0]), {"axis": "T"}),
-            "depth": (["depth"], np.linspace(0, maxdepth, dims[1]), {"axis": "Z"}),
-            "YC": (["YC"], np.arange(dims[2]) + 0.5, {"axis": "Y"}),
-            "YG": (["YG"], np.arange(dims[2]), {"axis": "Y", "c_grid_axis_shift": -0.5}),
-            "XC": (["XC"], np.arange(dims[3]) + 0.5, {"axis": "X"}),
-            "XG": (["XG"], np.arange(dims[3]), {"axis": "X", "c_grid_axis_shift": -0.5}),
-            "lat": (["YG"], np.linspace(-90, 90, dims[2]), {"axis": "Y", "c_grid_axis_shift": 0.5}),
-            "lon": (["XG"], np.linspace(-max_lon, max_lon, dims[3]), {"axis": "X", "c_grid_axis_shift": -0.5}),
-        },
-    )
-
-
 datasets = {
     "2d_left_rotated": _rotated_curvilinear_grid(),
     "ds_2d_left": xr.Dataset(  # MITgcm indexing style

tests/utils.py

@@ -9,7 +9,7 @@
 import xarray as xr
 
 import parcels
-from parcels._datasets.structured.generic import simple_UV_dataset
+from parcels._datasets.structured.generated import simple_UV_dataset
 from parcels.application_kernels.interpolation import XBiLinear
 from parcels.field import Field, VectorField
 from parcels.fieldset import FieldSet

tests/v4/test_advection.py

@@ -2,7 +2,7 @@
 import pytest
 import xarray as xr
 
-from parcels._datasets.structured.generic import simple_UV_dataset
+from parcels._datasets.structured.generated import simple_UV_dataset
 from parcels.application_kernels.advection import AdvectionEE, AdvectionRK4, AdvectionRK4_3D, AdvectionRK45
 from parcels.application_kernels.advectiondiffusion import AdvectionDiffusionEM, AdvectionDiffusionM1
 from parcels.application_kernels.interpolation import XBiLinear, XBiLinearPeriodic, XTriLinear

tests/v4/test_diffusion.py

@@ -4,7 +4,7 @@
 import pytest
 from scipy import stats
 
-from parcels._datasets.structured.generic import simple_UV_dataset
+from parcels._datasets.structured.generated import simple_UV_dataset
 from parcels.application_kernels import AdvectionDiffusionEM, AdvectionDiffusionM1, DiffusionUniformKh
 from parcels.application_kernels.interpolation import XBiLinear
 from parcels.field import Field, VectorField

tests/v4/test_interpolation.py

@@ -2,7 +2,7 @@
 import pytest
 import xarray as xr
 
-from parcels._datasets.structured.generic import simple_UV_dataset
+from parcels._datasets.structured.generated import simple_UV_dataset
 from parcels.application_kernels.advection import AdvectionRK4_3D
 from parcels.application_kernels.interpolation import XBiLinear, XTriLinear
 from parcels.field import Field, VectorField