update-patching

Author: VeckoTheGecko

docs/examples/example_globcurrent.py

@@ -1,4 +1,3 @@
-from collections.abc import Callable
 from datetime import timedelta
 from glob import glob
 
@@ -9,19 +8,6 @@
 import parcels
 
 
-def Unit_to_units(d: dict) -> dict:
-    if "Unit" in d:
-        d["units"] = d.pop("Unit")
-    return d
-
-
-def xarray_patch_metadata(ds: xr.Dataset, f: Callable[[dict], dict]) -> xr.Dataset:
-    """Convert attrs"""
-    for var in ds.variables:
-        ds[var].attrs = f(ds[var].attrs)
-    return ds
-
-
 def set_globcurrent_fieldset(
     filename=None,
 ):
@@ -35,11 +21,7 @@ def set_globcurrent_fieldset(
         "V": "northward_eulerian_current_velocity",
     }
     dimensions = {"lat": "lat", "lon": "lon", "time": "time"}
-    ds = (
-        xr.open_mfdataset(filename, combine="by_coords")
-        .pipe(xarray_patch_metadata, Unit_to_units)
-        .pipe(xr.decode_cf)
-    )
+    ds = xr.open_mfdataset(filename, combine="by_coords")
 
     return parcels.FieldSet.from_xarray_dataset(
         ds,

parcels/tools/_v3to4.py

@@ -0,0 +1,27 @@
+"""
+Temporary utilities to help with the transition from v3 to v4 of Parcels.
+
+TODO v4: Remove this module. Move functions that are still relevant into other modules
+"""
+
+from collections.abc import Callable
+
+import xarray as xr
+
+
+def Unit_to_units(d: dict) -> dict:
+    if "Unit" in d:
+        d["units"] = d.pop("Unit")
+    return d
+
+
+def xarray_patch_metadata(ds: xr.Dataset, f: Callable[[dict], dict]) -> xr.Dataset:
+    """Convert attrs"""
+    for var in ds.variables:
+        ds[var].attrs = f(ds[var].attrs)
+    return ds
+
+
+def patch_dataset_v4_compat(ds: xr.Dataset) -> xr.Dataset:
+    """Patches an xarray dataset to be compatible with v4"""
+    return ds.pipe(xarray_patch_metadata, Unit_to_units)

parcels/tools/exampledata_utils.py

@@ -4,6 +4,9 @@
 from urllib.request import urlretrieve
 
 import platformdirs
+import xarray as xr
+
+from parcels.tools._v3to4 import patch_dataset_v4_compat
 
 __all__ = ["download_example_dataset", "get_data_home", "list_example_datasets"]
 
@@ -146,5 +149,6 @@ def download_example_dataset(dataset: str, data_home=None):
         if not filepath.exists():
             url = f"{example_data_url}/{dataset}/{filename}"
             urlretrieve(url, str(filepath))
+            xr.load_dataset(filepath).pipe(patch_dataset_v4_compat).to_netcdf(filepath)
 
     return dataset_folder