roms-tools 3.0.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

roms_tools/tests/test_setup/test_surface_forcing.py

@@ -15,7 +15,8 @@ from roms_tools.download import download_test_data
 @pytest.fixture
 def grid_that_straddles_dateline():
     """Fixture for creating a domain that straddles the dateline and lies within the
-    bounds of the regional ERA5 data."""
+    bounds of the regional ERA5 data.
+    """
     grid = Grid(
         nx=20,
         ny=20,
@@ -78,7 +79,6 @@ def grid_that_lies_east_of_dateline_less_than_five_degrees_away():
     We care about the 5 degree mark because it decides whether the code handles the
     longitudes as straddling the dateline or not.
     """
-
     grid = Grid(
         nx=5,
         ny=5,
@@ -121,7 +121,6 @@ def grid_that_lies_west_of_dateline_less_than_five_degrees_away():
     We care about the 5 degree mark because it decides whether the code handles the
     longitudes as straddling the dateline or not.
     """
-
     grid = Grid(
         nx=5,
         ny=5,
@@ -143,7 +142,6 @@ def grid_that_lies_west_of_dateline_more_than_five_degrees_away():
     We care about the 5 degree mark because it decides whether the code handles the
     longitudes as straddling the dateline or not.
     """
-
     grid = Grid(
         nx=5,
         ny=5,
@@ -230,7 +228,6 @@ def test_successful_initialization_with_regional_data(
     - First with the default fine grid.
     - Then with the coarse grid enabled.
     """
-
     fname = Path(download_test_data("ERA5_regional_test_data.nc"))
     grid = request.getfixturevalue(grid_fixture)
 
@@ -268,7 +265,6 @@ def test_successful_initialization_with_global_data(
     including the correct handling of the grid and physics data. Checks both coarse and
     fine grid initialization.
     """
-
     fname = Path(download_test_data("ERA5_global_test_data.nc"))
     grid = request.getfixturevalue(grid_fixture)
 
@@ -307,7 +303,6 @@ def test_nan_detection_initialization_with_regional_data(
 
     for coarse_grid_mode in ["always", "never"]:
         with pytest.raises(ValueError, match="NaN values found"):
-
             SurfaceForcing(
                 grid=grid,
                 coarse_grid_mode=coarse_grid_mode,
@@ -336,7 +331,6 @@ def test_no_longitude_intersection_initialization_with_regional_data(
         with pytest.raises(
             ValueError, match="Selected longitude range does not intersect with dataset"
         ):
-
             SurfaceForcing(
                 grid=grid_that_straddles_180_degree_meridian,
                 coarse_grid_mode=coarse_grid_mode,
@@ -411,7 +405,6 @@ def test_nans_filled_in(
     - First with the default fine grid.
     - Then with the coarse grid enabled.
     """
-
     start_time = datetime(2020, 1, 31)
     end_time = datetime(2020, 2, 2)
 
@@ -447,8 +440,8 @@ def test_nans_filled_in(
 )
 def test_time_attr_climatology(bgc_surface_forcing_fixture, request):
     """Test that the 'cycle_length' attribute is present in the time coordinate of the
-    BGC dataset when using climatology data."""
-
+    BGC dataset when using climatology data.
+    """
     bgc_surface_forcing = request.getfixturevalue(bgc_surface_forcing_fixture)
     for time_coord in ["pco2_time", "iron_time", "dust_time", "nox_time", "nhy_time"]:
         assert hasattr(
@@ -460,7 +453,8 @@ def test_time_attr_climatology(bgc_surface_forcing_fixture, request):
 
 def test_time_attr(bgc_surface_forcing):
     """Test that the 'cycle_length' attribute is not present in the time coordinate of
-    the BGC dataset when not using climatology data."""
+    the BGC dataset when not using climatology data.
+    """
     for time_coord in ["pco2_time", "iron_time", "dust_time", "nox_time", "nhy_time"]:
         assert not hasattr(
             bgc_surface_forcing.ds[time_coord],
@@ -501,7 +495,6 @@ def test_surface_forcing_creation(
     Ensures that expected variables are present in the dataset and that attributes match
     the given configurations.
     """
-
     sfc_forcing = request.getfixturevalue(sfc_forcing_fixture)
 
     assert sfc_forcing.ds is not None
@@ -532,7 +525,6 @@ def test_surface_forcing_creation(
 )
 def test_surface_forcing_pco2_replication(sfc_forcing_fixture, request):
     """Test whether pco2_air and pco2_air_alt is the same after processing."""
-
     sfc_forcing = request.getfixturevalue(sfc_forcing_fixture)
 
     xr.testing.assert_allclose(
@@ -546,9 +538,9 @@ def test_computed_missing_optional_fields(bgc_surface_forcing_from_unified_clima
     # Use tight tolerances because 'nox' and 'nhy' can have values order 1e-12
 
     # 'nhy' was missing in the source data and should have been filled with a constant default value
-    assert np.allclose(
-        ds.nhy.std(), 0.0, rtol=1e-13, atol=1e-13
-    ), "NHy should be constant across space and time"
+    assert np.allclose(ds.nhy.std(), 0.0, rtol=1e-13, atol=1e-13), (
+        "NHy should be constant across space and time"
+    )
     # 'nox' was present in the source data and should show spatial or temporal variability
     assert ds.nox.std() > 1e-13, "NOx should vary across space and time"
 
@@ -605,7 +597,6 @@ def test_determine_usage_coarse_grid():
 
 
 def test_apply_wind_correction(surface_forcing):
-
     uwnd = surface_forcing.ds["uwnd"]
     vwnd = surface_forcing.ds["vwnd"]
 
@@ -668,7 +659,6 @@ def test_surface_forcing_save(sfc_forcing_fixture, request, tmp_path):
             tmp_path / file_str,
             str(tmp_path / file_str),
         ]:  # test for Path object and str
-
             # Test saving without grouping
             saved_filenames = sfc_forcing.save(filepath, group=False)
             filepath_str = str(Path(filepath).with_suffix(""))
@@ -702,14 +692,12 @@ def test_surface_forcing_bgc_plot(sfc_forcing_fixture, request):
 
 def test_surface_forcing_bgc_save(bgc_surface_forcing, tmp_path):
     """Test save method."""
-
     for file_str in ["test_sf", "test_sf.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [
             tmp_path / file_str,
             str(tmp_path / file_str),
         ]:  # test for Path object and str
-
             # Test saving without grouping
             saved_filenames = bgc_surface_forcing.save(filepath, group=False)
             filepath_str = str(Path(filepath).with_suffix(""))
@@ -736,7 +724,6 @@ def test_surface_forcing_bgc_save(bgc_surface_forcing, tmp_path):
 )
 def test_surface_forcing_bgc_from_clim_save(sfc_forcing_fixture, tmp_path, request):
     """Test save method."""
-
     bgc_surface_forcing_from_climatology = request.getfixturevalue(sfc_forcing_fixture)
 
     for file_str in ["test_sf", "test_sf.nc"]:
@@ -745,7 +732,6 @@ def test_surface_forcing_bgc_from_clim_save(sfc_forcing_fixture, tmp_path, reque
             tmp_path / file_str,
             str(tmp_path / file_str),
         ]:  # test for Path object and str
-
             # Test saving without grouping
             saved_filenames = bgc_surface_forcing_from_climatology.save(
                 filepath, group=False
@@ -781,8 +767,8 @@ def test_surface_forcing_bgc_from_clim_save(sfc_forcing_fixture, tmp_path, reque
 )
 def test_roundtrip_yaml(sfc_forcing_fixture, request, tmp_path, use_dask):
     """Test that creating an SurfaceForcing object, saving its parameters to yaml file,
-    and re-opening yaml file creates the same object."""
-
+    and re-opening yaml file creates the same object.
+    """
     sfc_forcing = request.getfixturevalue(sfc_forcing_fixture)
 
     # Create a temporary filepath using the tmp_path fixture
@@ -791,7 +777,6 @@ def test_roundtrip_yaml(sfc_forcing_fixture, request, tmp_path, use_dask):
         tmp_path / file_str,
         str(tmp_path / file_str),
     ]:  # test for Path object and str
-
         sfc_forcing.to_yaml(filepath)
 
         sfc_forcing_from_file = SurfaceForcing.from_yaml(filepath, use_dask)
@@ -813,7 +798,6 @@ def test_roundtrip_yaml(sfc_forcing_fixture, request, tmp_path, use_dask):
     ],
 )
 def test_files_have_same_hash(sfc_forcing_fixture, request, tmp_path, use_dask):
-
     sfc_forcing = request.getfixturevalue(sfc_forcing_fixture)
 
     yaml_filepath = tmp_path / "test_yaml.yaml"
@@ -849,7 +833,6 @@ def test_files_have_same_hash(sfc_forcing_fixture, request, tmp_path, use_dask):
     ],
 )
 def test_files_have_same_hash_clim(sfc_forcing_fixture, tmp_path, use_dask, request):
-
     bgc_surface_forcing_from_climatology = request.getfixturevalue(sfc_forcing_fixture)
 
     yaml_filepath = tmp_path / "test_yaml"
@@ -903,7 +886,6 @@ def test_from_yaml_missing_surface_forcing(tmp_path, use_dask):
         tmp_path / file_str,
         str(tmp_path / file_str),
     ]:  # test for Path object and str
-
         # Write YAML content to file
         if isinstance(yaml_filepath, Path):
             yaml_filepath.write_text(yaml_content)
@@ -923,8 +905,8 @@ def test_from_yaml_missing_surface_forcing(tmp_path, use_dask):
 @pytest.mark.stream
 def test_surface_forcing_arco(surface_forcing_arco, tmp_path):
     """One big integration test for cloud-based ERA5 data because the streaming takes a
-    long time."""
-
+    long time.
+    """
     # Test plotting
     surface_forcing_arco.plot(var_name="uwnd", time=0)
 

roms_tools/tests/test_setup/test_tides.py

@@ -11,7 +11,6 @@ from roms_tools.download import download_test_data
 
 @pytest.fixture(scope="session")
 def tidal_forcing_9v5a(use_dask):
-
     grid = Grid(
         nx=3, ny=3, size_x=1500, size_y=1500, center_lon=235, center_lat=25, rot=-20
     )
@@ -30,7 +29,6 @@ def tidal_forcing_9v5a(use_dask):
 
 @pytest.fixture(scope="session")
 def tidal_forcing_10v2a(use_dask):
-
     grid = Grid(
         nx=3, ny=3, size_x=1500, size_y=1500, center_lon=235, center_lat=25, rot=-20
     )
@@ -49,7 +47,6 @@ def tidal_forcing_10v2a(use_dask):
 
 @pytest.fixture(scope="session")
 def tidal_forcing_from_global_data(use_dask):
-
     grid = Grid(
         nx=3, ny=3, size_x=1800, size_y=1500, center_lon=235, center_lat=25, rot=-20
     )
@@ -115,7 +112,6 @@ def grid_that_straddles_dateline():
 @pytest.fixture
 def grid_that_straddles_180_degree_meridian():
     """Fixture for creating a domain that straddles 180 degree meridian."""
-
     grid = Grid(
         nx=5,
         ny=5,
@@ -138,7 +134,6 @@ def grid_that_straddles_180_degree_meridian():
     ],
 )
 def test_successful_initialization_with_global_data(grid_fixture, request, use_dask):
-
     fname_grid = Path(download_test_data("global_grid_tpxo10.v2.nc"))
     fname_h = Path(download_test_data("global_h_tpxo10.v2.nc"))
     fname_u = Path(download_test_data("global_u_tpxo10.v2.nc"))
@@ -170,7 +165,6 @@ def test_successful_initialization_with_global_data(grid_fixture, request, use_d
 def test_unsuccessful_initialization_with_regional_data_due_to_nans(
     grid_that_is_out_of_bounds_of_regional_tpxo_data, use_dask
 ):
-
     fname_grid = Path(download_test_data("regional_grid_tpxo10v2.nc"))
     fname_h = Path(download_test_data("regional_h_tpxo10v2.nc"))
     fname_u = Path(download_test_data("regional_u_tpxo10v2.nc"))
@@ -192,7 +186,6 @@ def test_unsuccessful_initialization_with_regional_data_due_to_nans(
 def test_unsuccessful_initialization_with_regional_data_due_to_no_overlap(
     grid_fixture, request, use_dask
 ):
-
     fname_grid = Path(download_test_data("regional_grid_tpxo10v2.nc"))
     fname_h = Path(download_test_data("regional_h_tpxo10v2.nc"))
     fname_u = Path(download_test_data("regional_u_tpxo10v2.nc"))
@@ -212,7 +205,6 @@ def test_unsuccessful_initialization_with_regional_data_due_to_no_overlap(
 
 
 def test_insufficient_number_of_consituents(grid_that_straddles_dateline, use_dask):
-
     fname_grid = Path(download_test_data("global_grid_tpxo10.v2.nc"))
     fname_h = Path(download_test_data("global_h_tpxo10.v2.nc"))
     fname_u = Path(download_test_data("global_u_tpxo10.v2.nc"))
@@ -229,20 +221,17 @@ def test_insufficient_number_of_consituents(grid_that_straddles_dateline, use_da
 
 def test_tidal_forcing_plot(tidal_forcing):
     """Test plot method."""
-
     tidal_forcing.plot(var_name="ssh_Re", ntides=0)
 
 
 def test_tidal_forcing_save(tidal_forcing, tmp_path):
     """Test save method."""
-
     for file_str in ["test_tides", "test_tides.nc"]:
         # Create a temporary filepath using the tmp_path fixture
         for filepath in [
             tmp_path / file_str,
             str(tmp_path / file_str),
         ]:  # test for Path object and str
-
             saved_filenames = tidal_forcing.save(filepath)
             # Check if the .nc file was created
             filepath = Path(filepath).with_suffix(".nc")
@@ -258,8 +247,8 @@ def test_tidal_forcing_save(tidal_forcing, tmp_path):
 )
 def test_roundtrip_yaml(tidal_forcing_fixture, tmp_path, use_dask, request):
     """Test that creating a TidalForcing object, saving its parameters to yaml file, and
-    re-opening yaml file creates the same object."""
-
+    re-opening yaml file creates the same object.
+    """
     tidal_forcing = request.getfixturevalue(tidal_forcing_fixture)
 
     # Create a temporary filepath using the tmp_path fixture
@@ -268,7 +257,6 @@ def test_roundtrip_yaml(tidal_forcing_fixture, tmp_path, use_dask, request):
         tmp_path / file_str,
         str(tmp_path / file_str),
     ]:  # test for Path object and str
-
         tidal_forcing.to_yaml(filepath)
 
         tidal_forcing_from_file = TidalForcing.from_yaml(filepath, use_dask=use_dask)
@@ -284,7 +272,6 @@ def test_roundtrip_yaml(tidal_forcing_fixture, tmp_path, use_dask, request):
     ["tidal_forcing", "tidal_forcing_from_global_data"],
 )
 def test_files_have_same_hash(tidal_forcing_fixture, tmp_path, use_dask, request):
-
     tidal_forcing = request.getfixturevalue(tidal_forcing_fixture)
 
     yaml_filepath = tmp_path / "test_yaml.yaml"
@@ -333,7 +320,6 @@ def test_from_yaml_missing_tidal_forcing(tmp_path, use_dask):
         tmp_path / file_str,
         str(tmp_path / file_str),
     ]:  # test for Path object and str
-
         # Write YAML content to file
         if isinstance(yaml_filepath, Path):
             yaml_filepath.write_text(yaml_content)

roms_tools/tests/test_setup/test_utils.py

@@ -1,3 +1,4 @@
+import logging
 from datetime import datetime
 from pathlib import Path
 
@@ -7,13 +8,10 @@ import xarray as xr
 from roms_tools import BoundaryForcing, Grid
 from roms_tools.download import download_test_data
 from roms_tools.setup.datasets import ERA5Correction
-from roms_tools.setup.utils import (
-    interpolate_from_climatology,
-)
+from roms_tools.setup.utils import interpolate_from_climatology, validate_names
 
 
 def test_interpolate_from_climatology(use_dask):
-
     fname = download_test_data("ERA5_regional_test_data.nc")
     era5_times = xr.open_dataset(fname).time
 
@@ -29,7 +27,6 @@ def test_interpolate_from_climatology(use_dask):
 @pytest.fixture()
 def boundary_forcing_from_multiple_source_files(request, use_dask):
     """Fixture for creating a BoundaryForcing object."""
-
     grid = Grid(
         nx=5,
         ny=5,
@@ -57,15 +54,14 @@ def test_roundtrip_yaml(
     boundary_forcing_from_multiple_source_files, request, tmp_path, use_dask
 ):
     """Test that creating a BoundaryForcing object, saving its parameters to yaml file,
-    and re-opening yaml file creates the same object."""
-
+    and re-opening yaml file creates the same object.
+    """
     # Create a temporary filepath using the tmp_path fixture
     file_str = "test_yaml"
     for filepath in [
         tmp_path / file_str,
         str(tmp_path / file_str),
     ]:  # test for Path object and str
-
         boundary_forcing_from_multiple_source_files.to_yaml(filepath)
 
         bdry_forcing_from_file = BoundaryForcing.from_yaml(filepath, use_dask=use_dask)
@@ -74,3 +70,53 @@ def test_roundtrip_yaml(
 
         filepath = Path(filepath)
         filepath.unlink()
+
+
+# test validate_names function
+
+VALID_NAMES = ["a", "b", "c", "d"]
+SENTINEL = "ALL"
+MAX_TO_PLOT = 3
+
+
+def test_valid_names_no_truncation():
+    names = ["a", "b"]
+    result = validate_names(names, VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="test")
+    assert result == names
+
+
+def test_valid_names_with_truncation(caplog):
+    names = ["a", "b", "c", "d"]
+    with caplog.at_level(logging.WARNING):
+        result = validate_names(
+            names, VALID_NAMES, SENTINEL, max_to_plot=2, label="test"
+        )
+        assert result == ["a", "b"]
+        assert "Only the first 2 tests will be plotted" in caplog.text
+
+
+def test_include_all_sentinel():
+    result = validate_names(SENTINEL, VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="test")
+    assert result == VALID_NAMES[:MAX_TO_PLOT]
+
+
+def test_invalid_name_raises():
+    with pytest.raises(ValueError, match="Invalid tests: z"):
+        validate_names(["a", "z"], VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="test")
+
+
+def test_non_list_input_raises():
+    with pytest.raises(ValueError, match="`test_names` should be a list of strings."):
+        validate_names("a", VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="test")
+
+
+def test_non_string_elements_in_list_raises():
+    with pytest.raises(
+        ValueError, match="All elements in `test_names` must be strings."
+    ):
+        validate_names(["a", 2], VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="test")
+
+
+def test_custom_label_in_errors():
+    with pytest.raises(ValueError, match="Invalid foozs: z"):
+        validate_names(["z"], VALID_NAMES, SENTINEL, MAX_TO_PLOT, label="fooz")

roms_tools/tests/test_setup/test_validation.py

@@ -35,7 +35,6 @@ def _get_fname(name):
 # to run it and overwrite the test data, invoke pytest as follows
 # pytest --overwrite=tidal_forcing --overwrite=boundary_forcing
 def test_save_results(forcing_fixture, request):
-
     overwrite = request.config.getoption("--overwrite")
 
     # Skip the test if the fixture isn't marked for overwriting, unless 'all' is specified
@@ -74,7 +73,6 @@ def test_save_results(forcing_fixture, request):
     ],
 )
 def test_check_results(forcing_fixture, request):
-
     fname = _get_fname(forcing_fixture)
     expected_forcing_ds = xr.open_zarr(fname, decode_timedelta=False)
     forcing = request.getfixturevalue(forcing_fixture)
@@ -101,7 +99,6 @@ def test_check_results(forcing_fixture, request):
 )
 def test_dask_vs_no_dask(forcing_fixture, request, tmp_path, use_dask):
     """Test comparing the forcing created with and without Dask on same platform."""
-
     if not use_dask:
         pytest.skip("Test only runs when --use_dask is specified")
 

roms_tools/tests/test_tiling/test_partition.py

@@ -9,7 +9,6 @@ from roms_tools.tiling.partition import partition, partition_netcdf
 
 @pytest.fixture
 def grid():
-
     grid = Grid(nx=30, ny=30, size_x=80, size_y=80, center_lon=-20, center_lat=0, rot=0)
 
     return grid
@@ -237,7 +236,8 @@ class TestPartitionGrid:
 
     def test_skip_coarse_dims(self, grid):
         """Test that coarse dimensions remain unchanged when excluded from
-        partitioning."""
+        partitioning.
+        """
         _, partitioned_datasets = partition(
             grid.ds, np_eta=10, np_xi=10, include_coarse_dims=False
         )

roms_tools/tiling/partition.py

@@ -1,6 +1,5 @@
 from numbers import Integral
 from pathlib import Path
-from typing import Union
 
 import numpy as np
 import xarray as xr
@@ -63,7 +62,6 @@ def partition(
     This example partitions the dataset into 2 tiles along the `eta` direction and 3 tiles
     along the `xi` direction, resulting in a total of 6 partitions.
     """
-
     if (
         not isinstance(np_eta, Integral)
         or np_eta < 1
@@ -298,7 +296,7 @@ def partition(
 
 
 def partition_netcdf(
-    filepath: Union[str, Path],
+    filepath: str | Path,
     np_eta: int = 1,
     np_xi: int = 1,
     include_coarse_dims: bool = True,
@@ -329,7 +327,6 @@ def partition_netcdf(
     List[Path]
         A list of Path objects for the filenames that were saved.
     """
-
     # Ensure filepath is a Path object
     filepath = Path(filepath)
 

roms_tools/utils.py

@@ -8,6 +8,8 @@ from pathlib import Path
 import numpy as np
 import xarray as xr
 
+from roms_tools.constants import R_EARTH
+
 
 def _load_data(
     filename,
@@ -78,7 +80,7 @@ def _load_data(
     wildcard_regex = re.compile(r"[\*\?\[\]]")
 
     # Convert Path objects to strings
-    if isinstance(filename, (str, Path)):
+    if isinstance(filename, str | Path):
         filename_str = str(filename)
     elif isinstance(filename, list):
         filename_str = [str(f) for f in filename]
@@ -139,7 +141,6 @@ def _load_data(
     }
 
     if use_dask:
-
         if "latitude" in dim_names and "longitude" in dim_names:
             # for lat-lon datasets
             chunks = {
@@ -241,7 +242,6 @@ def interpolate_from_rho_to_u(field, method="additive"):
     field_interpolated : xr.DataArray
         The interpolated data array on the u grid with the dimension "xi_u".
     """
-
     if method == "additive":
         field_interpolated = 0.5 * (field + field.shift(xi_rho=1)).isel(
             xi_rho=slice(1, None)
@@ -287,7 +287,6 @@ def interpolate_from_rho_to_v(field, method="additive"):
     field_interpolated : xr.DataArray
         The interpolated data array on the v grid with the dimension "eta_v".
     """
-
     if method == "additive":
         field_interpolated = 0.5 * (field + field.shift(eta_rho=1)).isel(
             eta_rho=slice(1, None)
@@ -325,7 +324,6 @@ def transpose_dimensions(da: xr.DataArray) -> xr.DataArray:
         The DataArray with dimensions reordered so that 'time', 's_*', 'eta_*',
         and 'xi_*' are first, in that order, if they exist.
     """
-
     # List of preferred dimension patterns
     preferred_order = ["time", "s_", "eta_", "xi_"]
 
@@ -368,7 +366,6 @@ def save_datasets(dataset_list, output_filenames, use_dask=False, verbose=True):
     List[Path]
         A list of Path objects for the filenames that were saved.
     """
-
     saved_filenames = []
 
     output_filenames = [f"{filename}.nc" for filename in output_filenames]
@@ -441,7 +438,6 @@ def _generate_coordinate_range(min_val: float, max_val: float, resolution: float
         An array of target coordinates generated from the specified range, with the resolution
         rounded to a suitable fraction (e.g., `1/n`) or integer, depending on the input resolution.
     """
-
     # Find the closest fraction of the form 1/n or integer to match the resolution
     resolution_rounded = None
     min_diff = float("inf")  # Initialize the minimum difference as infinity
@@ -522,7 +518,6 @@ def _generate_focused_coordinate_range(
     - Remaining faces are split evenly in the coarse resolution regions
     - Faces and centers are returned sorted and unique.
     """
-
     # Define the bounds of the high-res region
     if sc == 0.0:
         sc = 1
@@ -608,7 +603,6 @@ def _remove_edge_nans(
                 nan_mask = field.isnull()
 
         elif len(other_dims) == 1:
-
             depth_dim = other_dims[0]
 
             if layer_depth is not None:
@@ -669,3 +663,44 @@ def normalize_longitude(lon: float, straddle: bool) -> float:
         return lon - 360 if lon > 180 else lon
     else:
         return lon + 360 if lon < 0 else lon
+
+
+def infer_nominal_horizontal_resolution(
+    grid_ds: xr.Dataset, lat: float | None = None
+) -> float:
+    """Estimate the nominal horizontal resolution of the ROMS grid in degrees at a
+    specified latitude.
+
+    This function calculates the average horizontal grid spacing (based on `pm` and `pn`),
+    then converts that spacing from meters to degrees longitude, accounting for Earth's curvature
+    and the cosine of the latitude.
+
+    Parameters
+    ----------
+    grid_ds : xr.Dataset
+        ROMS grid dataset containing `pm`, `pn`, and `lat_rho` coordinates.
+    lat : float, optional
+        Latitude (in degrees) at which to estimate resolution. If None, the average latitude
+        over the grid is used.
+
+    Returns
+    -------
+    float
+        Estimated nominal horizontal resolution in degrees longitude.
+    """
+    if lat is None:
+        # Use center of the domain in latitude
+        lat = float((grid_ds.lat_rho.max() + grid_ds.lat_rho.min()) / 2)
+
+    lat_rad = np.deg2rad(lat)
+
+    # Mean grid spacing in meters (pm and pn are in 1/m)
+    resolution_in_m = ((1 / grid_ds.pm).mean() + (1 / grid_ds.pn).mean()) / 2
+
+    # Meters per degree at the equator
+    meters_per_degree = 2 * np.pi * R_EARTH / 360
+
+    # Adjust resolution to degrees longitude at the specified latitude
+    resolution_in_degrees = resolution_in_m / (meters_per_degree * np.cos(lat_rad))
+
+    return float(resolution_in_degrees)

roms_tools/vertical_coordinate.py

@@ -106,7 +106,6 @@ def compute_depth(zeta, h, hc, cs, sigma):
     z : xr.DataArray
         The depth at different sigma levels.
     """
-
     z = (hc * sigma + h * cs) / (hc + h)
     z = zeta + (zeta + h) * z
 
@@ -120,8 +119,8 @@ def compute_depth_coordinates(
     zeta: xr.DataArray | float = 0,
     depth_type: str = "layer",
     location: str = "rho",
-    eta: int = None,
-    xi: int = None,
+    eta: int | None = None,
+    xi: int | None = None,
 ) -> "xr.DataArray":
     """Compute vertical depth coordinates for a given ROMS grid location.