roms-tools 3.2.0__py3-none-any.whl → 3.3.0__py3-none-any.whl

roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/zarr.json

@@ -1,7 +1,7 @@
 {
   "attributes": {
     "title": "ROMS tidal forcing created by ROMS-Tools",
-    "roms_tools_version": "2.6.1.dev52+gd44fe5da",
+    "roms_tools_version": "3.1.3.dev32+g91d580e67.d20250929",
     "source": "TPXO",
     "model_reference_date": "2000-01-01 00:00:00"
   },
@@ -10,20 +10,21 @@
     "kind": "inline",
     "must_understand": false,
     "metadata": {
-      "v_Im": {
+      "ntides": {
         "shape": [
-          1,
-          4,
-          5
+          1
         ],
-        "data_type": "float32",
+        "data_type": {
+          "name": "null_terminated_bytes",
+          "configuration": {
+            "length_bytes": 3
+          }
+        },
         "chunk_grid": {
           "name": "regular",
           "configuration": {
             "chunk_shape": [
-              1,
-              4,
-              5
+              1
             ]
           }
         },
@@ -33,13 +34,10 @@
             "separator": "/"
           }
         },
-        "fill_value": 0.0,
+        "fill_value": "",
         "codecs": [
           {
-            "name": "bytes",
-            "configuration": {
-              "endian": "little"
-            }
+            "name": "bytes"
           },
           {
             "name": "zstd",
@@ -50,35 +48,29 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal velocity in y-direction, complex part",
-          "units": "m/s",
-          "coordinates": "omega",
-          "_FillValue": "AAAAAAAA+H8="
+          "long_name": "constituent label"
         },
         "dimension_names": [
-          "ntides",
-          "eta_v",
-          "xi_rho"
+          "ntides"
         ],
         "zarr_format": 3,
         "node_type": "array",
         "storage_transformers": []
       },
-      "ntides": {
+      "pot_Im": {
         "shape": [
-          1
+          1,
+          5,
+          5
         ],
-        "data_type": {
-          "name": "null_terminated_bytes",
-          "configuration": {
-            "length_bytes": 3
-          }
-        },
+        "data_type": "float32",
         "chunk_grid": {
           "name": "regular",
           "configuration": {
             "chunk_shape": [
-              1
+              1,
+              5,
+              5
             ]
           }
         },
@@ -88,10 +80,13 @@
             "separator": "/"
           }
         },
-        "fill_value": "",
+        "fill_value": 0.0,
         "codecs": [
           {
-            "name": "bytes"
+            "name": "bytes",
+            "configuration": {
+              "endian": "little"
+            }
           },
           {
             "name": "zstd",
@@ -102,16 +97,21 @@
           }
         ],
         "attributes": {
-          "long_name": "constituent label"
+          "long_name": "Tidal potential, complex part",
+          "units": "m",
+          "coordinates": "omega",
+          "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
-          "ntides"
+          "ntides",
+          "eta_rho",
+          "xi_rho"
         ],
         "zarr_format": 3,
         "node_type": "array",
         "storage_transformers": []
       },
-      "ssh_Re": {
+      "pot_Re": {
         "shape": [
           1,
           5,
@@ -151,7 +151,7 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal elevation, real part",
+          "long_name": "Tidal potential, real part",
           "units": "m",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
@@ -165,10 +165,10 @@
         "node_type": "array",
         "storage_transformers": []
       },
-      "pot_Im": {
+      "v_Im": {
         "shape": [
           1,
-          5,
+          4,
           5
         ],
         "data_type": "float32",
@@ -177,7 +177,7 @@
           "configuration": {
             "chunk_shape": [
               1,
-              5,
+              4,
               5
             ]
           }
@@ -205,24 +205,24 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal potential, complex part",
-          "units": "m",
+          "long_name": "Tidal velocity in y-direction, complex part",
+          "units": "m/s",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
           "ntides",
-          "eta_rho",
+          "eta_v",
           "xi_rho"
         ],
         "zarr_format": 3,
         "node_type": "array",
         "storage_transformers": []
       },
-      "ssh_Im": {
+      "v_Re": {
         "shape": [
           1,
-          5,
+          4,
           5
         ],
         "data_type": "float32",
@@ -231,7 +231,7 @@
           "configuration": {
             "chunk_shape": [
               1,
-              5,
+              4,
               5
             ]
           }
@@ -259,24 +259,24 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal elevation, complex part",
-          "units": "m",
+          "long_name": "Tidal velocity in y-direction, real part",
+          "units": "m/s",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
           "ntides",
-          "eta_rho",
+          "eta_v",
           "xi_rho"
         ],
         "zarr_format": 3,
         "node_type": "array",
         "storage_transformers": []
       },
-      "v_Re": {
+      "ssh_Re": {
         "shape": [
           1,
-          4,
+          5,
           5
         ],
         "data_type": "float32",
@@ -285,7 +285,7 @@
           "configuration": {
             "chunk_shape": [
               1,
-              4,
+              5,
               5
             ]
           }
@@ -313,14 +313,14 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal velocity in y-direction, real part",
-          "units": "m/s",
+          "long_name": "Tidal elevation, real part",
+          "units": "m",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
           "ntides",
-          "eta_v",
+          "eta_rho",
           "xi_rho"
         ],
         "zarr_format": 3,
@@ -428,11 +428,11 @@
         "node_type": "array",
         "storage_transformers": []
       },
-      "u_Im": {
+      "ssh_Im": {
         "shape": [
           1,
           5,
-          4
+          5
         ],
         "data_type": "float32",
         "chunk_grid": {
@@ -441,7 +441,7 @@
             "chunk_shape": [
               1,
               5,
-              4
+              5
             ]
           }
         },
@@ -468,25 +468,25 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal velocity in x-direction, complex part",
-          "units": "m/s",
+          "long_name": "Tidal elevation, complex part",
+          "units": "m",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
           "ntides",
           "eta_rho",
-          "xi_u"
+          "xi_rho"
         ],
         "zarr_format": 3,
         "node_type": "array",
         "storage_transformers": []
       },
-      "pot_Re": {
+      "u_Im": {
         "shape": [
           1,
           5,
-          5
+          4
         ],
         "data_type": "float32",
         "chunk_grid": {
@@ -495,7 +495,7 @@
             "chunk_shape": [
               1,
               5,
-              5
+              4
             ]
           }
         },
@@ -522,15 +522,15 @@
           }
         ],
         "attributes": {
-          "long_name": "Tidal potential, real part",
-          "units": "m",
+          "long_name": "Tidal velocity in x-direction, complex part",
+          "units": "m/s",
           "coordinates": "omega",
           "_FillValue": "AAAAAAAA+H8="
         },
         "dimension_names": [
           "ntides",
           "eta_rho",
-          "xi_rho"
+          "xi_u"
         ],
         "zarr_format": 3,
         "node_type": "array",

roms_tools/tests/test_setup/test_grid.py

@@ -236,6 +236,20 @@ def test_plot(grid_that_straddles_180_degree_meridian):
     grid_that_straddles_180_degree_meridian.plot(with_dim_names=True)
 
 
+def test_plot_wide_grid():
+    # This grid should be handled via different cartopy projection
+    grid = Grid(
+        nx=10,
+        ny=10,
+        size_x=15000,
+        size_y=15000,
+        center_lon=-161,
+        center_lat=14.4,
+        rot=-3,
+    )
+    grid.plot()
+
+
 @pytest.mark.skipif(xesmf is None, reason="xesmf required")
 def test_plot_along_lat_lon(grid_that_straddles_180_degree_meridian):
     grid_that_straddles_180_degree_meridian.plot(lat=61)

roms_tools/tests/test_setup/test_initial_conditions.py

@@ -11,7 +11,7 @@ import xarray as xr
 from conftest import calculate_data_hash
 from roms_tools import Grid, InitialConditions
 from roms_tools.download import download_test_data
-from roms_tools.setup.datasets import (
+from roms_tools.setup.lat_lon_datasets import (
     CESMBGCDataset,
     UnifiedBGCDataset,
 )

roms_tools/tests/test_setup/{test_datasets.py → test_lat_lon_datasets.py}

@@ -9,15 +9,14 @@ import pytest
 import xarray as xr
 
 from roms_tools.download import download_test_data
-from roms_tools.setup.datasets import (
+from roms_tools.setup.lat_lon_datasets import (
     GLORYS_GLOBAL_GRID_PATH,
     CESMBGCDataset,
-    Dataset,
     ERA5ARCODataset,
     ERA5Correction,
     GLORYSDataset,
     GLORYSDefaultDataset,
-    RiverDataset,
+    LatLonDataset,
     TPXODataset,
     _concatenate_longitudes,
     choose_subdomain,
@@ -158,7 +157,7 @@ def test_select_times(data_fixture, expected_time_values, request, tmp_path, use
 
     filepath = tmp_path / "test.nc"
     dataset.to_netcdf(filepath)
-    dataset = Dataset(
+    dataset = LatLonDataset(
         filename=filepath,
         var_names={"var": "var"},
         start_time=start_time,
@@ -192,7 +191,7 @@ def test_select_times_valid_start_no_end_time(
     dataset.to_netcdf(filepath)
 
     # Instantiate Dataset object using the temporary file
-    dataset = Dataset(
+    dataset = LatLonDataset(
         filename=filepath,
         var_names={"var": "var"},
         start_time=start_time,
@@ -229,7 +228,7 @@ def test_select_times_invalid_start_no_end_time(
         ValueError,
         match="No exact match found ",
     ):
-        dataset = Dataset(
+        dataset = LatLonDataset(
             filename=filepath,
             var_names={"var": "var"},
             start_time=datetime(2022, 5, 1),
@@ -245,7 +244,7 @@ def test_multiple_matching_times(
     """
     filepath = tmp_path / "test.nc"
     global_dataset_with_multiple_times_per_day.to_netcdf(filepath)
-    dataset = Dataset(
+    dataset = LatLonDataset(
         filename=filepath,
         var_names={"var": "var"},
         start_time=datetime(2021, 12, 31, 22, 0),
@@ -265,7 +264,7 @@ def test_warnings_times(global_dataset, tmp_path, caplog, use_dask):
         start_time = datetime(2021, 1, 1)
         end_time = datetime(2021, 2, 1)
 
-        Dataset(
+        LatLonDataset(
             filename=filepath,
             var_names={"var": "var"},
             start_time=start_time,
@@ -279,7 +278,7 @@ def test_warnings_times(global_dataset, tmp_path, caplog, use_dask):
         start_time = datetime(2024, 1, 1)
         end_time = datetime(2024, 2, 1)
 
-        Dataset(
+        LatLonDataset(
             filename=filepath,
             var_names={"var": "var"},
             start_time=start_time,
@@ -291,13 +290,13 @@ def test_warnings_times(global_dataset, tmp_path, caplog, use_dask):
 
 
 def test_from_ds(global_dataset, global_dataset_with_noon_times, use_dask, tmp_path):
-    """Test the from_ds method of the Dataset class."""
+    """Test the from_ds method of the LatLonDataset class."""
     start_time = datetime(2022, 1, 1)
 
     filepath = tmp_path / "test.nc"
     global_dataset.to_netcdf(filepath)
 
-    dataset = Dataset(
+    dataset = LatLonDataset(
         filename=filepath,
         var_names={"var": "var"},
         dim_names={
@@ -311,9 +310,9 @@ def test_from_ds(global_dataset, global_dataset_with_noon_times, use_dask, tmp_p
         allow_flex_time=True,
     )
 
-    new_dataset = Dataset.from_ds(dataset, global_dataset_with_noon_times)
+    new_dataset = LatLonDataset.from_ds(dataset, global_dataset_with_noon_times)
 
-    assert isinstance(new_dataset, Dataset)  # Check that the new instance is a Dataset
+    assert isinstance(new_dataset, LatLonDataset)
     assert new_dataset.ds.equals(
         global_dataset_with_noon_times
     )  # Verify the new ds attribute is set correctly
@@ -330,7 +329,7 @@ def test_reverse_latitude_reverse_depth_choose_subdomain(
     global_dataset, tmp_path, use_dask
 ):
     """Test reversing latitude when it is not ascending, the choose_subdomain method,
-    and the convert_to_negative_depth method of the Dataset class.
+    and the convert_to_negative_depth method of the LatLonDataset class.
     """
     start_time = datetime(2022, 1, 1)
 
@@ -339,7 +338,7 @@ def test_reverse_latitude_reverse_depth_choose_subdomain(
     global_dataset["depth"] = global_dataset["depth"][::-1]
     global_dataset.to_netcdf(filepath)
 
-    dataset = Dataset(
+    dataset = LatLonDataset(
         filename=filepath,
         var_names={"var": "var"},
         dim_names={
@@ -393,7 +392,9 @@ def test_reverse_latitude_reverse_depth_choose_subdomain(
 def test_check_if_global_with_global_dataset(global_dataset, tmp_path, use_dask):
     filepath = tmp_path / "test.nc"
     global_dataset.to_netcdf(filepath)
-    dataset = Dataset(filename=filepath, var_names={"var": "var"}, use_dask=use_dask)
+    dataset = LatLonDataset(
+        filename=filepath, var_names={"var": "var"}, use_dask=use_dask
+    )
     is_global = dataset.check_if_global(dataset.ds)
     assert is_global
 
@@ -403,7 +404,9 @@ def test_check_if_global_with_non_global_dataset(
 ):
     filepath = tmp_path / "test.nc"
     non_global_dataset.to_netcdf(filepath)
-    dataset = Dataset(filename=filepath, var_names={"var": "var"}, use_dask=use_dask)
+    dataset = LatLonDataset(
+        filename=filepath, var_names={"var": "var"}, use_dask=use_dask
+    )
     is_global = dataset.check_if_global(dataset.ds)
 
     assert not is_global
@@ -421,7 +424,7 @@ def test_check_dataset(global_dataset, tmp_path, use_dask):
     with pytest.raises(
         ValueError, match="Dataset does not contain all required variables."
     ):
-        Dataset(
+        LatLonDataset(
             filename=filepath,
             var_names={"var": "var"},
             start_time=start_time,
@@ -440,7 +443,7 @@ def test_check_dataset(global_dataset, tmp_path, use_dask):
     with pytest.raises(
         ValueError, match="Dataset does not contain all required dimensions."
     ):
-        Dataset(
+        LatLonDataset(
             filename=filepath,
             var_names={"var": "var"},
             start_time=start_time,
@@ -760,48 +763,6 @@ class TestTPXODataset:
             global_tpxo_dataset.select_constituents(11, omega)
 
 
-class TestRiverDataset:
-    def test_deduplicate_river_names(self, tmp_path):
-        sample_dim_and_var_names = {
-            "dim_names": {"station": "station", "time": "time"},
-            "var_names": {
-                "latitude": "lat",
-                "longitude": "lon",
-                "flux": "flux",
-                "ratio": "ratio",
-                "name": "name",
-            },
-        }
-
-        data = {
-            "lat": (["station"], [10.0, 20.0, 30.0]),
-            "lon": (["station"], [100.0, 110.0, 120.0]),
-            "flux": (["time", "station"], np.random.rand(1, 3)),
-            "ratio": (["time", "station"], np.random.rand(1, 3)),
-            "name": (["station"], ["Amazon", "Nile", "Amazon"]),  # duplicate
-        }
-        coords = {"station": [0, 1, 2], "time": [0]}
-        ds = xr.Dataset(data, coords=coords)
-
-        # Write to temporary NetCDF file
-        file_path = tmp_path / "rivers.nc"
-        ds.to_netcdf(file_path)
-
-        river_dataset = RiverDataset(
-            filename=file_path,
-            start_time=datetime(2000, 1, 1),
-            end_time=datetime(2000, 1, 2),
-            dim_names=sample_dim_and_var_names["dim_names"],
-            var_names=sample_dim_and_var_names["var_names"],
-        )
-
-        names = river_dataset.ds["name"].values
-        assert "Amazon_1" in names
-        assert "Amazon_2" in names
-        assert "Nile" in names
-        assert len(set(names)) == len(names)  # all names must be unique
-
-
 # test _concatenate_longitudes