roms-tools 1.7.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/Cs_r/.zattrs

@@ -2,6 +2,6 @@
     "_ARRAY_DIMENSIONS": [
         "s_rho"
     ],
-    "long_name": "S-coordinate stretching curves at rho-points",
+    "long_name": "Vertical stretching function at rho-points",
     "units": "nondimensional"
 }

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/Cs_w/.zattrs

@@ -2,6 +2,6 @@
     "_ARRAY_DIMENSIONS": [
         "s_w"
     ],
-    "long_name": "S-coordinate stretching curves at w-points",
+    "long_name": "Vertical stretching function at w-points",
     "units": "nondimensional"
 }

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/h/.zattrs

@@ -4,6 +4,6 @@
         "xi_rho"
     ],
     "coordinates": "lat_rho lon_rho",
-    "long_name": "Final bathymetry at rho-points",
+    "long_name": "Bathymetry at rho-points",
     "units": "meter"
 }

roms_tools/tests/test_setup/test_data/{grid.zarr/interface_depth_v → grid_that_straddles_dateline.zarr/sigma_r}/.zarray

@@ -1,8 +1,6 @@
 {
     "chunks": [
-        101,
-        2,
-        3
+        100
     ],
     "compressor": {
         "blocksize": 0,
@@ -16,9 +14,7 @@
     "filters": null,
     "order": "C",
     "shape": [
-        101,
-        2,
-        3
+        100
     ],
     "zarr_format": 2
 }

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/sigma_r/.zattrs

@@ -0,0 +1,7 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "s_rho"
+    ],
+    "long_name": "Fractional vertical stretching coordinate at rho-points",
+    "units": "nondimensional"
+}

roms_tools/tests/test_setup/test_data/{grid.zarr/layer_depth_rho → grid_that_straddles_dateline.zarr/sigma_w}/.zarray

@@ -1,8 +1,6 @@
 {
     "chunks": [
-        100,
-        3,
-        3
+        101
     ],
     "compressor": {
         "blocksize": 0,
@@ -16,9 +14,7 @@
     "filters": null,
     "order": "C",
     "shape": [
-        100,
-        3,
-        3
+        101
     ],
     "zarr_format": 2
 }

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/sigma_w/.zattrs

@@ -0,0 +1,7 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "s_w"
+    ],
+    "long_name": "Fractional vertical stretching coordinate at w-points",
+    "units": "nondimensional"
+}

roms_tools/tests/test_setup/test_grid.py

@@ -114,7 +114,7 @@ def test_plot_save_methods(tmp_path):
 
 
 def test_raise_if_domain_too_large():
-    with pytest.raises(ValueError, match="Domain size has to be smaller"):
+    with pytest.raises(ValueError, match="Domain size exceeds"):
         Grid(nx=3, ny=3, size_x=30000, size_y=30000, center_lon=0, center_lat=51.5)
 
     # test grid with reasonable domain size
@@ -181,12 +181,6 @@ def test_compatability_with_matlab_grid(tmp_path):
             "lon_v",
             "lat_coarse",
             "lon_coarse",
-            "layer_depth_rho",
-            "layer_depth_u",
-            "layer_depth_v",
-            "interface_depth_rho",
-            "interface_depth_u",
-            "interface_depth_v",
         ]
     )
     actual_coords = set(grid.ds.coords.keys())
@@ -229,7 +223,7 @@ def test_roundtrip_netcdf(tmp_path):
         center_lon=0.0,
         center_lat=0.0,
         rot=0.0,
-        topography_source="ETOPO5",
+        topography_source={"name": "ETOPO5"},
         hmin=5.0,
     )
 
@@ -267,7 +261,7 @@ def test_roundtrip_yaml(tmp_path):
         center_lon=0.0,
         center_lat=0.0,
         rot=0.0,
-        topography_source="ETOPO5",
+        topography_source={"name": "ETOPO5"},
         hmin=5.0,
     )
 
@@ -300,7 +294,7 @@ def test_files_have_same_hash(tmp_path):
         center_lon=0.0,
         center_lat=0.0,
         rot=0.0,
-        topography_source="ETOPO5",
+        topography_source={"name": "ETOPO5"},
         hmin=5.0,
     )
 
@@ -336,7 +330,8 @@ def test_from_yaml_missing_version(tmp_path):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )
@@ -405,7 +400,8 @@ def test_from_yaml_version_mismatch(tmp_path, caplog):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )
@@ -432,3 +428,105 @@ def test_from_yaml_version_mismatch(tmp_path, caplog):
 
         yaml_filepath = Path(yaml_filepath)
         yaml_filepath.unlink()
+
+
+def test_invalid_theta_s_value():
+    """Test the validation of the theta_s value."""
+    with pytest.raises(ValueError):
+
+        Grid(
+            nx=2,
+            ny=2,
+            size_x=500,
+            size_y=1000,
+            center_lon=0,
+            center_lat=55,
+            rot=10,
+            N=3,
+            theta_s=11.0,  # Invalid value, should be 0 < theta_s <= 10
+            theta_b=2.0,
+            hc=250.0,
+        )
+
+
+def test_invalid_theta_b_value():
+    """Test the validation of the theta_b value."""
+    with pytest.raises(ValueError):
+        Grid(
+            nx=2,
+            ny=2,
+            size_x=500,
+            size_y=1000,
+            center_lon=0,
+            center_lat=55,
+            rot=10,
+            N=3,
+            theta_s=5.0,
+            theta_b=5.0,  # Invalid value, should be 0 < theta_b <= 4
+            hc=250.0,
+        )
+
+
+def test_update_vertical_coordinate():
+
+    grid = Grid(
+        nx=2, ny=2, size_x=500, size_y=1000, center_lon=0, center_lat=55, rot=10
+    )
+
+    assert grid.N == 100
+    assert grid.theta_s == 5.0
+    assert grid.theta_b == 2.0
+    assert grid.hc == 300.0
+    assert len(grid.ds.s_rho) == 100
+
+    grid.update_vertical_coordinate(N=3, theta_s=10.0, theta_b=1.0, hc=400.0)
+
+    assert grid.N == 3
+    assert grid.theta_s == 10.0
+    assert grid.theta_b == 1.0
+    assert grid.hc == 400.0
+    assert len(grid.ds.s_rho) == 3
+
+    grid.update_vertical_coordinate(N=5)
+
+    assert grid.N == 5
+    assert grid.theta_s == 10.0
+    assert grid.theta_b == 1.0
+    assert grid.hc == 400.0
+    assert len(grid.ds.s_rho) == 5
+
+    grid.update_vertical_coordinate()
+
+    assert grid.N == 5
+    assert grid.theta_s == 10.0
+    assert grid.theta_b == 1.0
+    assert grid.hc == 400.0
+    assert len(grid.ds.s_rho) == 5
+
+
+def test_plot():
+    grid = Grid(
+        nx=2,
+        ny=2,
+        size_x=500,
+        size_y=1000,
+        center_lon=0,
+        center_lat=55,
+        rot=10,
+        N=3,
+        theta_s=5.0,
+        theta_b=2.0,
+        hc=250.0,
+    )
+    grid.plot_vertical_coordinate(s=-1)
+    grid.plot_vertical_coordinate(eta=0)
+    grid.plot_vertical_coordinate(xi=0)
+
+    with pytest.raises(ValueError, match="Exactly one of"):
+        grid.plot_vertical_coordinate(s=-1, eta=0)
+    with pytest.raises(ValueError, match="Exactly one of"):
+        grid.plot_vertical_coordinate(s=-1, xi=0)
+    with pytest.raises(ValueError, match="Exactly one of"):
+        grid.plot_vertical_coordinate(eta=-1, xi=0)
+    with pytest.raises(ValueError, match="Exactly one of"):
+        grid.plot_vertical_coordinate(eta=-1, xi=0, s=-1)

roms_tools/tests/test_setup/test_initial_conditions.py

@@ -308,7 +308,8 @@ def test_from_yaml_missing_initial_conditions(tmp_path, use_dask):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )

roms_tools/tests/test_setup/test_river_forcing.py

@@ -323,7 +323,7 @@ def test_files_have_same_hash(river_forcing, tmp_path):
     grid_filepath2.unlink()
 
 
-def test_from_yaml_missing_initial_conditions(tmp_path):
+def test_from_yaml_missing_river_forcing(tmp_path):
     yaml_content = textwrap.dedent(
         """\
     ---
@@ -337,7 +337,8 @@ def test_from_yaml_missing_initial_conditions(tmp_path):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )

roms_tools/tests/test_setup/test_surface_forcing.py

@@ -153,27 +153,6 @@ def grid_that_lies_west_of_dateline_more_than_five_degrees_away():
     return grid
 
 
-@pytest.fixture
-def grid_that_straddles_180_degree_meridian():
-    """Fixture for creating a domain that straddles 180 degree meridian.
-
-    This is a good test grid for the global ERA5 data, which comes on an [-180, 180]
-    longitude grid.
-    """
-
-    grid = Grid(
-        nx=5,
-        ny=5,
-        size_x=1800,
-        size_y=2400,
-        center_lon=180,
-        center_lat=61,
-        rot=20,
-    )
-
-    return grid
-
-
 @pytest.mark.parametrize(
     "grid_fixture",
     [
@@ -747,7 +726,8 @@ def test_from_yaml_missing_surface_forcing(tmp_path, use_dask):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )

roms_tools/tests/test_setup/test_tides.py

@@ -266,7 +266,8 @@ def test_from_yaml_missing_tidal_forcing(tmp_path, use_dask):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
     """
     )

roms_tools/tests/test_setup/test_topography.py

@@ -1,5 +1,7 @@
+import pytest
 from roms_tools import Grid
 from roms_tools.setup.topography import _compute_rfactor
+from roms_tools.setup.download import download_test_data
 import numpy as np
 import numpy.testing as npt
 from scipy.ndimage import label
@@ -52,7 +54,13 @@ def test_hmin_criterion():
     assert grid.hmin == 5.0
     assert np.less_equal(grid.hmin, grid.ds.h.min())
 
-    grid.update_topography_and_mask(hmin=10.0)
+    grid.update_topography(hmin=10.0)
+
+    assert grid.hmin == 10.0
+    assert np.less_equal(grid.hmin, grid.ds.h.min())
+
+    # this should not do anything
+    grid.update_topography()
 
     assert grid.hmin == 10.0
     assert np.less_equal(grid.hmin, grid.ds.h.min())
@@ -94,3 +102,100 @@ def test_mask_topography_boundary():
     np.testing.assert_array_equal(
         grid.ds.mask_rho.isel(xi_rho=-1).data, grid.ds.mask_rho.isel(xi_rho=-2).data
     )
+
+
+@pytest.fixture()
+def grid_that_straddles_dateline_with_shifted_global_etopo_data():
+
+    grid = Grid(
+        nx=5,
+        ny=5,
+        size_x=1000,
+        size_y=1000,
+        center_lon=0,
+        center_lat=0,
+        rot=20,
+        topography_source={
+            "name": "ETOPO5",
+            "path": download_test_data("etopo5_coarsened_and_shifted.nc"),
+        },
+    )
+
+    return grid
+
+
+@pytest.fixture()
+def grid_that_straddles_dateline_with_global_srtm15_data():
+
+    grid = Grid(
+        nx=5,
+        ny=5,
+        size_x=1000,
+        size_y=1000,
+        center_lon=0,
+        center_lat=0,
+        rot=20,
+        topography_source={
+            "name": "SRTM15",
+            "path": download_test_data("srtm15_coarsened.nc"),
+        },
+    )
+
+    return grid
+
+
+@pytest.fixture()
+def grid_that_straddles_180_degree_meridian_with_shifted_global_etopo_data():
+
+    grid = Grid(
+        nx=5,
+        ny=5,
+        size_x=1000,
+        size_y=1000,
+        center_lon=180,
+        center_lat=0,
+        rot=20,
+        topography_source={
+            "name": "ETOPO5",
+            "path": download_test_data("etopo5_coarsened_and_shifted.nc"),
+        },
+    )
+
+    return grid
+
+
+@pytest.fixture()
+def grid_that_straddles_180_degree_meridian_with_global_srtm15_data():
+
+    grid = Grid(
+        nx=5,
+        ny=5,
+        size_x=1000,
+        size_y=1000,
+        center_lon=180,
+        center_lat=0,
+        rot=20,
+        topography_source={
+            "name": "SRTM15",
+            "path": download_test_data("srtm15_coarsened.nc"),
+        },
+    )
+
+    return grid
+
+
+@pytest.mark.parametrize(
+    "grid_fixture",
+    [
+        "grid_that_straddles_dateline",
+        "grid_that_straddles_180_degree_meridian",
+        "grid_that_straddles_dateline_with_shifted_global_etopo_data",
+        "grid_that_straddles_180_degree_meridian_with_shifted_global_etopo_data",
+        "grid_that_straddles_dateline_with_global_srtm15_data",
+        "grid_that_straddles_180_degree_meridian_with_global_srtm15_data",
+    ],
+)
+def test_successful_initialization(grid_fixture, request):
+
+    grid = request.getfixturevalue(grid_fixture)
+    assert grid is not None

{roms_tools-1.7.0.dist-info → roms_tools-2.0.0.dist-info}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 [C-Worthy]
+   Copyright 2024 [C]-Worthy LLC.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{roms_tools-1.7.0.dist-info → roms_tools-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 1.7.0
+Version: 2.0.0
 Summary: Tools for running and analysing UCLA-ROMS simulations
 Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>
 License: Apache-2
@@ -31,6 +31,7 @@ Requires-Dist: netcdf4
 Requires-Dist: PyYAML
 Requires-Dist: pyamg
 Requires-Dist: bottleneck
+Requires-Dist: regionmask
 Provides-Extra: dask
 Requires-Dist: dask[diagnostics]; extra == "dask"