roms-tools 2.4.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

roms_tools/setup/tides.py

@@ -8,7 +8,7 @@ from pathlib import Path
 from dataclasses import dataclass, field
 from roms_tools import Grid
 from roms_tools.plot import _plot
-from roms_tools.regrid import LateralRegrid
+from roms_tools.regrid import LateralRegridToROMS
 from roms_tools.utils import save_datasets
 from roms_tools.setup.datasets import TPXODataset
 from roms_tools.setup.utils import (
@@ -25,7 +25,7 @@ from roms_tools.setup.utils import (
 )
 
 
-@dataclass(frozen=True, kw_only=True)
+@dataclass(kw_only=True)
 class TidalForcing:
     """Represents tidal forcing for ROMS.
 
@@ -84,8 +84,11 @@ class TidalForcing:
             target_coords,
             buffer_points=20,
         )
+        # Enforce double precision to ensure reproducibility
+        data.convert_to_float64()
+
         # select desired number of constituents
-        object.__setattr__(data, "ds", data.ds.isel(ntides=slice(None, self.ntides)))
+        data.ds = data.ds.isel(ntides=slice(None, self.ntides))
         self._correct_tides(data)
 
         data.apply_lateral_fill()
@@ -95,7 +98,7 @@ class TidalForcing:
 
         processed_fields = {}
         # lateral regridding
-        lateral_regrid = LateralRegrid(target_coords, data.dim_names)
+        lateral_regrid = LateralRegridToROMS(target_coords, data.dim_names)
         for var_name in var_names:
             if var_name in data.var_names.keys():
                 processed_fields[var_name] = lateral_regrid.apply(
@@ -141,7 +144,7 @@ class TidalForcing:
         for var_name in ds.data_vars:
             ds[var_name] = substitute_nans_by_fillvalue(ds[var_name])
 
-        object.__setattr__(self, "ds", ds)
+        self.ds = ds
 
     def _input_checks(self):
 
@@ -215,7 +218,7 @@ class TidalForcing:
             },
         }
 
-        object.__setattr__(self, "variable_info", variable_info)
+        self.variable_info = variable_info
 
     def _write_into_dataset(self, processed_fields, d_meta):
 
@@ -416,7 +419,6 @@ class TidalForcing:
         cls,
         filepath: Union[str, Path],
         use_dask: bool = False,
-        bypass_validation: bool = False,
     ) -> "TidalForcing":
         """Create an instance of the TidalForcing class from a YAML file.
 
@@ -426,10 +428,6 @@ class TidalForcing:
             The path to the YAML file from which the parameters will be read.
         use_dask: bool, optional
             Indicates whether to use dask for processing. If True, data is processed with dask; if False, data is processed eagerly. Defaults to False.
-        bypass_validation: bool, optional
-            Indicates whether to skip validation checks in the processed data. When set to True,
-            the validation process that ensures no NaN values exist at wet points
-            in the processed dataset is bypassed. Defaults to False.
 
         Returns
         -------
@@ -444,7 +442,6 @@ class TidalForcing:
             grid=grid,
             **tidal_forcing_params,
             use_dask=use_dask,
-            bypass_validation=bypass_validation,
         )
 
     def _correct_tides(self, data):
@@ -507,7 +504,7 @@ class TidalForcing:
         var_names.pop("sal_Re", None)  # Remove "sal_Re" if it exists
         var_names.pop("sal_Im", None)  # Remove "sal_Im" if it exists
 
-        object.__setattr__(data, "var_names", var_names)
+        data.var_names = var_names
 
 
 def modified_julian_days(year, month, day, hour=0):

roms_tools/setup/topography.py

@@ -6,7 +6,7 @@ import gcm_filters
 from roms_tools.setup.utils import handle_boundaries
 import warnings
 from itertools import count
-from roms_tools.regrid import LateralRegrid
+from roms_tools.regrid import LateralRegridToROMS
 from roms_tools.setup.datasets import ETOPO5Dataset, SRTM15Dataset
 
 
@@ -145,10 +145,12 @@ def _make_raw_topography(
         The regridded topography data with the sign flipped (bathymetry positive).
     """
     data.choose_subdomain(target_coords, buffer_points=3, verbose=verbose)
+    # Enforce double precision to ensure reproducibility
+    data.convert_to_float64()
 
     if verbose:
         start_time = time.time()
-    lateral_regrid = LateralRegrid(target_coords, data.dim_names)
+    lateral_regrid = LateralRegridToROMS(target_coords, data.dim_names)
     hraw = lateral_regrid.apply(data.ds[data.var_names["topo"]], method=method)
     if verbose:
         logging.info(
@@ -233,7 +235,7 @@ def _smooth_topography_locally(h, hmin=5, rmax=0.2):
         rmax_log = 0.0
 
     # Apply hmin threshold
-    h = xr.where(h < hmin, hmin, h)
+    h = _clip_depth(h, hmin)
 
     # Perform logarithmic transformation of the height field
     h_log = np.log(h / hmin)
@@ -316,7 +318,7 @@ def _smooth_topography_locally(h, hmin=5, rmax=0.2):
         h = hmin * np.exp(h_log)
 
         # Apply hmin threshold again
-        h = xr.where(h < hmin, hmin, h)
+        h = _clip_depth(h, hmin)
 
         # Compute maximum slope parameter r
         r_eta, r_xi = _compute_rfactor(h)
@@ -327,6 +329,27 @@ def _smooth_topography_locally(h, hmin=5, rmax=0.2):
     return h
 
 
+def _clip_depth(h: xr.DataArray, hmin: float) -> xr.DataArray:
+    """Ensures that depth values do not fall below a minimum threshold.
+
+    This function replaces all depth values in `h` that are less than `hmin` with `hmin`,
+    ensuring a minimum depth constraint.
+
+    Parameters
+    ----------
+    h : xr.DataArray
+        The depth (bathymetry) array.
+    hmin : float
+        The minimum allowable depth value.
+
+    Returns
+    -------
+    xr.DataArray
+        The modified depth array with values clipped at `hmin`.
+    """
+    return xr.where(h < hmin, hmin, h)
+
+
 def _compute_rfactor(h):
     """Computes the slope parameter (r-factor) in both horizontal directions.
 

roms_tools/setup/utils.py

@@ -893,13 +893,9 @@ def _to_yaml(forcing_object, filepath: Union[str, Path]) -> None:
     if hasattr(forcing_object, "grid") and forcing_object.grid is not None:
         grid_data = asdict(forcing_object.grid)
         grid_yaml_data = {"Grid": _pop_grid_data(grid_data)}
-    else:
-        parent_grid_data = asdict(forcing_object.parent_grid)
-        parent_grid_yaml_data = {"ParentGrid": _pop_grid_data(parent_grid_data)}
-        child_grid_data = asdict(forcing_object.child_grid)
-        child_grid_yaml_data = {"ChildGrid": _pop_grid_data(child_grid_data)}
-
-        grid_yaml_data = {**parent_grid_yaml_data, **child_grid_yaml_data}
+    elif hasattr(forcing_object, "parent_grid"):
+        grid_data = asdict(forcing_object.parent_grid)
+        grid_yaml_data = {"ParentGrid": _pop_grid_data(grid_data)}
 
     # Step 2: Ensure Paths are Strings
     def ensure_paths_are_strings(obj, key):
@@ -933,11 +929,12 @@ def _to_yaml(forcing_object, filepath: Union[str, Path]) -> None:
         not in (
             "grid",
             "parent_grid",
-            "child_grid",
             "ds",
             "use_dask",
-            "bypass_validation",
             "climatology",
+            "verbose",
+            "straddle",
+            "indices",
         )
     ]
 
@@ -952,18 +949,37 @@ def _to_yaml(forcing_object, filepath: Union[str, Path]) -> None:
         # Add the field and its value to the forcing_data dictionary
         forcing_data[field_name] = value
 
-    # Step 5: Combine Grid and Forcing Data into a single dictionary for the final YAML content
+    # Step 5: Serialize `indices` data (conditionally)
+    indices_data = getattr(forcing_object, "indices", None)
+    if indices_data is not None:
+        serialized_indices = {
+            "_convention": "eta_rho, xi_rho"
+        }  # Add convention metadata
+
+        for key, value in indices_data.items():
+            serialized_indices[key] = [
+                f"{tup[0]}, {tup[1]}" for tup in value
+            ]  # Comma-separated string
+
+        forcing_data["indices"] = serialized_indices
+
+    # Step 6: Combine Grid and Forcing Data into a single dictionary for the final YAML content
     yaml_data = {
         **grid_yaml_data,  # Add the grid data to the final YAML structure
         forcing_object.__class__.__name__: forcing_data,  # Include the serialized forcing object data
     }
 
-    # Step 6: Write to YAML file
+    # Step 7: Write to YAML file
     with filepath.open("w") as file:
         # Write the header first
         file.write(header)
         # Write the serialized YAML data
-        yaml.dump(yaml_data, file, default_flow_style=False, sort_keys=False)
+        yaml.dump(
+            yaml_data,
+            file,
+            default_flow_style=False,
+            sort_keys=False,
+        )
 
 
 def _pop_grid_data(grid_data):