roms-tools 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

roms_tools/setup/utils.py

@@ -165,27 +165,31 @@ def interpolate_from_rho_to_v(field, method="additive"):
 
 def extrapolate_deepest_to_bottom(field: xr.DataArray, dim: str) -> xr.DataArray:
     """
-    Extrapolate the deepest non-NaN values to the bottom along a specified dimension.
+    Extrapolates the deepest non-NaN values to the bottom along the specified dimension using forward fill.
+
+    This function assumes that the specified dimension is ordered from top to bottom (e.g., a vertical dimension like 'depth').
+    It fills `NaN` values below the deepest valid (non-NaN) entry along the given dimension by carrying forward the last valid value.
 
     Parameters
     ----------
     field : xr.DataArray
-        The input data array containing NaN values that need to be filled. This array
-        should have at least one dimension named by `dim`.
+        The input `xarray.DataArray` containing potential `NaN` values to be filled.
+        This array must have at least one dimension corresponding to `dim`, typically
+        a vertical axis such as 'depth' or 'height'.
     dim : str
-        The name of the dimension along which to perform the interpolation and extrapolation.
-        Typically, this would be a vertical dimension such as 'depth' or 's_rho'.
+        The name of the dimension along which to perform the forward fill operation.
+        The function assumes that this dimension is ordered from top to bottom, with
+        larger index values representing deeper or lower levels.
 
     Returns
     -------
-    field_interpolated : xr.DataArray
-        A new data array with NaN values along the specified dimension filled by nearest
-        neighbor interpolation and extrapolation to the bottom. The original data array is not modified.
+    xr.DataArray
+        A new `xarray.DataArray` with the `NaN` values along the specified dimension
+        filled by forward filling the deepest valid values down to the bottom.
+        The original input data remains unmodified.
 
     """
-    field_interpolated = field.interpolate_na(
-        dim=dim, method="nearest", fill_value="extrapolate"
-    )
+    field_interpolated = field.ffill(dim=dim)
 
     return field_interpolated
 
@@ -300,19 +304,19 @@ def interpolate_from_climatology(
         raise TypeError("Input 'field' must be an xarray.DataArray or xarray.Dataset.")
 
 
-def is_cftime_datetime(data_array: xr.DataArray) -> bool:
+def get_time_type(data_array: xr.DataArray) -> str:
     """
-    Checks if the xarray DataArray contains cftime datetime objects.
+    Determines the type of time values in the xarray DataArray.
 
     Parameters
     ----------
     data_array : xr.DataArray
-        The xarray DataArray to be checked for cftime datetime objects.
+        The xarray DataArray to be checked for time data types.
 
     Returns
     -------
-    bool
-        True if the DataArray contains cftime datetime objects, False otherwise.
+    str
+        A string indicating the type of the time data: 'cftime', 'datetime', or 'int'.
 
     Raises
     ------
@@ -324,16 +328,26 @@ def is_cftime_datetime(data_array: xr.DataArray) -> bool:
         cftime.DatetimeNoLeap,
         cftime.DatetimeJulian,
         cftime.DatetimeGregorian,
+        cftime.Datetime360Day,
+        cftime.DatetimeProlepticGregorian,
     )
 
-    # Check if any of the coordinate values are of cftime type
+    # Check if any of the coordinate values are of cftime, datetime, or integer type
     if isinstance(data_array.values, (np.ndarray, list)):
-        # Check the dtype of the array; numpy datetime64 indicates it's not cftime
+        # Check if the data type is numpy datetime64, indicating standard datetime objects
         if data_array.values.dtype == "datetime64[ns]":
-            return False
+            return "datetime"
 
-        # Check if any of the values in the array are instances of cftime types
-        return any(isinstance(value, cftime_types) for value in data_array.values)
+        # Check if any values in the array are instances of cftime types
+        if any(isinstance(value, cftime_types) for value in data_array.values):
+            return "cftime"
+
+        # Check if all values are of integer type (e.g., for indices or time steps)
+        if np.issubdtype(data_array.values.dtype, np.integer):
+            return "int"
+
+        # If none of the above conditions are met, raise a ValueError
+        raise ValueError("Unsupported data type for time values in input dataset.")
 
     # Handle unexpected types
     raise TypeError("DataArray values must be of type numpy.ndarray or list.")
@@ -599,8 +613,12 @@ def group_dataset(ds, filepath):
         if len(ds["abs_time"]) > 2:
             # Determine the frequency of the data
             abs_time_freq = pd.infer_freq(ds["abs_time"].to_index())
-
-            if abs_time_freq in ["D", "H", "T", "S"]:  # Daily or higher frequency
+            if abs_time_freq.lower() in [
+                "d",
+                "h",
+                "t",
+                "s",
+            ]:  # Daily or higher frequency
                 dataset_list, output_filenames = group_by_month(ds, filepath)
             else:
                 dataset_list, output_filenames = group_by_year(ds, filepath)

roms_tools/tests/test_setup/test_boundary_forcing.py

@@ -199,7 +199,7 @@ def test_roundtrip_yaml(bdry_forcing_fixture, request, tmp_path, use_dask):
 
 def test_files_have_same_hash(boundary_forcing, tmp_path, use_dask):
 
-    yaml_filepath = tmp_path / "test_yaml"
+    yaml_filepath = tmp_path / "test_yaml_.yaml"
     filepath1 = tmp_path / "test1.nc"
     filepath2 = tmp_path / "test2.nc"
 

roms_tools/tests/test_setup/test_data/bgc_boundary_forcing_from_climatology.zarr/.zattrs

@@ -3,7 +3,7 @@
     "end_time": "2021-06-30 00:00:00",
     "hc": 250.0,
     "model_reference_date": "2000-01-01 00:00:00",
-    "roms_tools_version": "0.1.dev98",
+    "roms_tools_version": "0.1.dev152+dirty",
     "source": "CESM_REGRIDDED",
     "start_time": "2021-06-29 00:00:00",
     "theta_b": 2.0,

roms_tools/tests/test_setup/test_data/bgc_boundary_forcing_from_climatology.zarr/.zmetadata

@@ -5,7 +5,7 @@
             "end_time": "2021-06-30 00:00:00",
             "hc": 250.0,
             "model_reference_date": "2000-01-01 00:00:00",
-            "roms_tools_version": "0.1.dev98",
+            "roms_tools_version": "0.1.dev152+dirty",
             "source": "CESM_REGRIDDED",
             "start_time": "2021-06-29 00:00:00",
             "theta_b": 2.0,

roms_tools/tests/test_setup/test_data/bgc_surface_forcing.zarr/.zattrs

@@ -2,7 +2,7 @@
     "correct_radiation": "False",
     "end_time": "2020-02-01 00:00:00",
     "model_reference_date": "2000-01-01 00:00:00",
-    "roms_tools_version": "0.1.dev98",
+    "roms_tools_version": "0.1.dev152+dirty",
     "source": "CESM_REGRIDDED",
     "start_time": "2020-02-01 00:00:00",
     "title": "ROMS surface forcing file created by ROMS-Tools",

roms_tools/tests/test_setup/test_data/bgc_surface_forcing.zarr/.zmetadata

@@ -4,7 +4,7 @@
             "correct_radiation": "False",
             "end_time": "2020-02-01 00:00:00",
             "model_reference_date": "2000-01-01 00:00:00",
-            "roms_tools_version": "0.1.dev98",
+            "roms_tools_version": "0.1.dev152+dirty",
             "source": "CESM_REGRIDDED",
             "start_time": "2020-02-01 00:00:00",
             "title": "ROMS surface forcing file created by ROMS-Tools",

roms_tools/tests/test_setup/test_data/bgc_surface_forcing_from_climatology.zarr/.zattrs

@@ -3,7 +3,7 @@
     "correct_radiation": "False",
     "end_time": "2020-02-01 00:00:00",
     "model_reference_date": "2000-01-01 00:00:00",
-    "roms_tools_version": "0.1.dev98",
+    "roms_tools_version": "0.1.dev152+dirty",
     "source": "CESM_REGRIDDED",
     "start_time": "2020-02-01 00:00:00",
     "title": "ROMS surface forcing file created by ROMS-Tools",

roms_tools/tests/test_setup/test_data/bgc_surface_forcing_from_climatology.zarr/.zmetadata

@@ -5,7 +5,7 @@
             "correct_radiation": "False",
             "end_time": "2020-02-01 00:00:00",
             "model_reference_date": "2000-01-01 00:00:00",
-            "roms_tools_version": "0.1.dev98",
+            "roms_tools_version": "0.1.dev152+dirty",
             "source": "CESM_REGRIDDED",
             "start_time": "2020-02-01 00:00:00",
             "title": "ROMS surface forcing file created by ROMS-Tools",

roms_tools/tests/test_setup/test_data/boundary_forcing.zarr/.zattrs

@@ -2,7 +2,7 @@
     "end_time": "2021-06-30 00:00:00",
     "hc": 250.0,
     "model_reference_date": "2000-01-01 00:00:00",
-    "roms_tools_version": "0.1.dev98",
+    "roms_tools_version": "0.1.dev152+dirty",
     "source": "GLORYS",
     "start_time": "2021-06-29 00:00:00",
     "theta_b": 2.0,

roms_tools/tests/test_setup/test_data/boundary_forcing.zarr/.zmetadata

@@ -4,7 +4,7 @@
             "end_time": "2021-06-30 00:00:00",
             "hc": 250.0,
             "model_reference_date": "2000-01-01 00:00:00",
-            "roms_tools_version": "0.1.dev98",
+            "roms_tools_version": "0.1.dev152+dirty",
             "source": "GLORYS",
             "start_time": "2021-06-29 00:00:00",
             "theta_b": 2.0,