roms-tools 1.5.0__py3-none-any.whl → 1.6.1__py3-none-any.whl

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.dev138+dirty",
+    "roms_tools_version": "0.1.dev157+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.dev138+dirty",
+            "roms_tools_version": "0.1.dev157+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/.zmetadata

@@ -38,7 +38,10 @@
             "_ARRAY_DIMENSIONS": [
                 "bry_time"
             ],
+            "axis": "T",
             "calendar": "gregorian",
+            "long_name": "Time",
+            "standard_name": "time",
             "units": "seconds since 1970-01-01"
         },
         "bry_time/.zarray": {
@@ -889,6 +892,7 @@
             ],
             "coordinates": "abs_time",
             "long_name": "eastern boundary sea surface height",
+            "standard_name": "sea_surface_height_above_geoid",
             "units": "m"
         },
         "zeta_north/.zarray": {
@@ -920,6 +924,7 @@
             ],
             "coordinates": "abs_time",
             "long_name": "northern boundary sea surface height",
+            "standard_name": "sea_surface_height_above_geoid",
             "units": "m"
         },
         "zeta_south/.zarray": {
@@ -951,6 +956,7 @@
             ],
             "coordinates": "abs_time",
             "long_name": "southern boundary sea surface height",
+            "standard_name": "sea_surface_height_above_geoid",
             "units": "m"
         },
         "zeta_west/.zarray": {
@@ -982,6 +988,7 @@
             ],
             "coordinates": "abs_time",
             "long_name": "western boundary sea surface height",
+            "standard_name": "sea_surface_height_above_geoid",
             "units": "m"
         }
     },

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

@@ -2,6 +2,9 @@
     "_ARRAY_DIMENSIONS": [
         "bry_time"
     ],
+    "axis": "T",
     "calendar": "gregorian",
+    "long_name": "Time",
+    "standard_name": "time",
     "units": "seconds since 1970-01-01"
 }

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

@@ -5,5 +5,6 @@
     ],
     "coordinates": "abs_time",
     "long_name": "eastern boundary sea surface height",
+    "standard_name": "sea_surface_height_above_geoid",
     "units": "m"
 }

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

@@ -5,5 +5,6 @@
     ],
     "coordinates": "abs_time",
     "long_name": "northern boundary sea surface height",
+    "standard_name": "sea_surface_height_above_geoid",
     "units": "m"
 }

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

@@ -5,5 +5,6 @@
     ],
     "coordinates": "abs_time",
     "long_name": "southern boundary sea surface height",
+    "standard_name": "sea_surface_height_above_geoid",
     "units": "m"
 }

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

@@ -5,5 +5,6 @@
     ],
     "coordinates": "abs_time",
     "long_name": "western boundary sea surface height",
+    "standard_name": "sea_surface_height_above_geoid",
     "units": "m"
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,7 +1,7 @@
 {
     "allan_factor": 2.0,
     "model_reference_date": "2000-01-01 00:00:00",
-    "roms_tools_version": "0.1.dev152+dirty",
+    "roms_tools_version": "0.1.dev157+dirty",
     "source": "TPXO",
     "title": "ROMS tidal forcing created by ROMS-Tools"
 }

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

@@ -3,7 +3,7 @@
         ".zattrs": {
             "allan_factor": 2.0,
             "model_reference_date": "2000-01-01 00:00:00",
-            "roms_tools_version": "0.1.dev152+dirty",
+            "roms_tools_version": "0.1.dev157+dirty",
             "source": "TPXO",
             "title": "ROMS tidal forcing created by ROMS-Tools"
         },
@@ -33,7 +33,9 @@
         "omega/.zattrs": {
             "_ARRAY_DIMENSIONS": [
                 "ntides"
-            ]
+            ],
+            "long_name": "Tidal frequencies",
+            "units": "1/s"
         },
         "pot_Im/.zarray": {
             "chunks": [

roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/omega/.zattrs

@@ -1,5 +1,7 @@
 {
     "_ARRAY_DIMENSIONS": [
         "ntides"
-    ]
+    ],
+    "long_name": "Tidal frequencies",
+    "units": "1/s"
 }

roms_tools/tests/test_setup/test_datasets.py

@@ -259,6 +259,42 @@ def test_warnings_times(global_dataset, tmp_path, 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."""
+
+    start_time = datetime(2022, 1, 1)
+
+    filepath = tmp_path / "test.nc"
+    global_dataset.to_netcdf(filepath)
+
+    dataset = Dataset(
+        filename=filepath,
+        var_names={"var": "var"},
+        dim_names={
+            "latitude": "latitude",
+            "longitude": "longitude",
+            "time": "time",
+            "depth": "depth",
+        },
+        start_time=start_time,
+        use_dask=use_dask,
+    )
+
+    new_dataset = Dataset.from_ds(dataset, global_dataset_with_noon_times)
+
+    assert isinstance(new_dataset, Dataset)  # Check that the new instance is a Dataset
+    assert new_dataset.ds.equals(
+        global_dataset_with_noon_times
+    )  # Verify the new ds attribute is set correctly
+
+    # Ensure other attributes are copied correctly
+    for attr in vars(dataset):
+        if attr != "ds":
+            assert getattr(new_dataset, attr) == getattr(
+                dataset, attr
+            ), f"Attribute {attr} not copied correctly."
+
+
 def test_reverse_latitude_reverse_depth_choose_subdomain(
     global_dataset, tmp_path, use_dask
 ):
@@ -288,31 +324,37 @@ def test_reverse_latitude_reverse_depth_choose_subdomain(
     assert np.all(np.diff(dataset.ds["depth"]) > 0)
 
     # test choosing subdomain for domain that straddles the dateline
-    ds = dataset.choose_subdomain(
-        latitude_range=(-10, 10),
-        longitude_range=(-10, 10),
-        margin=1,
-        straddle=True,
-        return_subdomain=True,
+    target_coords = {
+        "lat": xr.DataArray(np.linspace(-10, 10, 100)),
+        "lon": xr.DataArray(np.linspace(-10, 10, 100)),
+        "straddle": True,
+    }
+    sub_dataset = dataset.choose_subdomain(
+        target_coords,
+        buffer_points=1,
+        return_copy=True,
     )
 
-    assert -11 <= ds["latitude"].min() <= 11
-    assert -11 <= ds["latitude"].max() <= 11
-    assert -11 <= ds["longitude"].min() <= 11
-    assert -11 <= ds["longitude"].max() <= 11
-
-    ds = dataset.choose_subdomain(
-        latitude_range=(-10, 10),
-        longitude_range=(10, 20),
-        margin=1,
-        straddle=False,
-        return_subdomain=True,
+    assert -11 <= sub_dataset.ds["latitude"].min() <= 11
+    assert -11 <= sub_dataset.ds["latitude"].max() <= 11
+    assert -11 <= sub_dataset.ds["longitude"].min() <= 11
+    assert -11 <= sub_dataset.ds["longitude"].max() <= 11
+
+    target_coords = {
+        "lat": xr.DataArray(np.linspace(-10, 10, 100)),
+        "lon": xr.DataArray(np.linspace(10, 20, 100)),
+        "straddle": False,
+    }
+    sub_dataset = dataset.choose_subdomain(
+        target_coords,
+        buffer_points=1,
+        return_copy=True,
     )
 
-    assert -11 <= ds["latitude"].min() <= 11
-    assert -11 <= ds["latitude"].max() <= 11
-    assert 9 <= ds["longitude"].min() <= 21
-    assert 9 <= ds["longitude"].max() <= 21
+    assert -11 <= sub_dataset.ds["latitude"].min() <= 11
+    assert -11 <= sub_dataset.ds["latitude"].max() <= 11
+    assert 9 <= sub_dataset.ds["longitude"].min() <= 21
+    assert 9 <= sub_dataset.ds["longitude"].max() <= 21
 
 
 def test_check_if_global_with_global_dataset(global_dataset, tmp_path, use_dask):
@@ -475,3 +517,19 @@ def test_climatology_error(use_dask):
             climatology=False,
             use_dask=use_dask,
         )
+
+
+@pytest.mark.parametrize(
+    "data_fixture, expected_resolution",
+    [
+        ("era5_data", 0.25),
+        ("glorys_data", 1 / 12),
+        ("tpxo_data", 1 / 6),
+        ("cesm_bgc_data", 1.0),
+        ("cesm_surface_bgc_data", 1.0),
+    ],
+)
+def test_horizontal_resolution(data_fixture, expected_resolution, request):
+
+    data = request.getfixturevalue(data_fixture)
+    assert np.isclose(data.resolution, expected_resolution)