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

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

@@ -0,0 +1,185 @@
+{
+    "metadata": {
+        ".zattrs": {},
+        ".zgroup": {
+            "zarr_format": 2
+        },
+        "abs_time/.zarray": {
+            "chunks": [
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<i8",
+            "fill_value": null,
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4
+            ],
+            "zarr_format": 2
+        },
+        "abs_time/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "river_time"
+            ],
+            "calendar": "proleptic_gregorian",
+            "long_name": "absolute time",
+            "units": "days since 1997-12-15 00:00:00"
+        },
+        "river_name/.zarray": {
+            "chunks": [
+                6
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "|O",
+            "fill_value": null,
+            "filters": [
+                {
+                    "id": "vlen-utf8"
+                }
+            ],
+            "order": "C",
+            "shape": [
+                6
+            ],
+            "zarr_format": 2
+        },
+        "river_name/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "nriver"
+            ],
+            "long_name": "River name"
+        },
+        "river_time/.zarray": {
+            "chunks": [
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f8",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4
+            ],
+            "zarr_format": 2
+        },
+        "river_time/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "river_time"
+            ],
+            "long_name": "relative time: days since 2000-01-01 00:00:00",
+            "units": "days"
+        },
+        "river_tracer/.zarray": {
+            "chunks": [
+                4,
+                2,
+                6
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f4",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                2,
+                6
+            ],
+            "zarr_format": 2
+        },
+        "river_tracer/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "river_time",
+                "ntracers",
+                "nriver"
+            ],
+            "coordinates": "abs_time river_name tracer_name",
+            "long_name": "River tracer data",
+            "units": "degrees C [temperature]; psu [salinity]"
+        },
+        "river_volume/.zarray": {
+            "chunks": [
+                4,
+                6
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f4",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                6
+            ],
+            "zarr_format": 2
+        },
+        "river_volume/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "river_time",
+                "nriver"
+            ],
+            "coordinates": "abs_time river_name",
+            "long_name": "River volume flux",
+            "units": "m^3/s"
+        },
+        "tracer_name/.zarray": {
+            "chunks": [
+                2
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<U11",
+            "fill_value": null,
+            "filters": null,
+            "order": "C",
+            "shape": [
+                2
+            ],
+            "zarr_format": 2
+        },
+        "tracer_name/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "ntracers"
+            ],
+            "long_name": "Tracer name"
+        }
+    },
+    "zarr_consolidated_format": 1
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/abs_time/.zarray

@@ -0,0 +1,20 @@
+{
+    "chunks": [
+        4
+    ],
+    "compressor": {
+        "blocksize": 0,
+        "clevel": 5,
+        "cname": "lz4",
+        "id": "blosc",
+        "shuffle": 1
+    },
+    "dtype": "<i8",
+    "fill_value": null,
+    "filters": null,
+    "order": "C",
+    "shape": [
+        4
+    ],
+    "zarr_format": 2
+}

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

@@ -0,0 +1,8 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "river_time"
+    ],
+    "calendar": "proleptic_gregorian",
+    "long_name": "absolute time",
+    "units": "days since 1997-12-15 00:00:00"
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_name/.zarray

@@ -0,0 +1,24 @@
+{
+    "chunks": [
+        6
+    ],
+    "compressor": {
+        "blocksize": 0,
+        "clevel": 5,
+        "cname": "lz4",
+        "id": "blosc",
+        "shuffle": 1
+    },
+    "dtype": "|O",
+    "fill_value": null,
+    "filters": [
+        {
+            "id": "vlen-utf8"
+        }
+    ],
+    "order": "C",
+    "shape": [
+        6
+    ],
+    "zarr_format": 2
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_name/.zattrs

@@ -0,0 +1,6 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "nriver"
+    ],
+    "long_name": "River name"
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_time/.zarray

@@ -0,0 +1,20 @@
+{
+    "chunks": [
+        4
+    ],
+    "compressor": {
+        "blocksize": 0,
+        "clevel": 5,
+        "cname": "lz4",
+        "id": "blosc",
+        "shuffle": 1
+    },
+    "dtype": "<f8",
+    "fill_value": "NaN",
+    "filters": null,
+    "order": "C",
+    "shape": [
+        4
+    ],
+    "zarr_format": 2
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_time/.zattrs

@@ -0,0 +1,7 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "river_time"
+    ],
+    "long_name": "relative time: days since 2000-01-01 00:00:00",
+    "units": "days"
+}

roms_tools/tests/test_setup/test_data/{grid_that_straddles_dateline.zarr/interface_depth_v → river_forcing_no_climatology.zarr/river_tracer}/.zarray

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

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_tracer/.zattrs

@@ -0,0 +1,10 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "river_time",
+        "ntracers",
+        "nriver"
+    ],
+    "coordinates": "abs_time river_name tracer_name",
+    "long_name": "River tracer data",
+    "units": "degrees C [temperature]; psu [salinity]"
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_volume/.zarray

@@ -0,0 +1,22 @@
+{
+    "chunks": [
+        4,
+        6
+    ],
+    "compressor": {
+        "blocksize": 0,
+        "clevel": 5,
+        "cname": "lz4",
+        "id": "blosc",
+        "shuffle": 1
+    },
+    "dtype": "<f4",
+    "fill_value": "NaN",
+    "filters": null,
+    "order": "C",
+    "shape": [
+        4,
+        6
+    ],
+    "zarr_format": 2
+}

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/river_volume/.zattrs

@@ -0,0 +1,9 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "river_time",
+        "nriver"
+    ],
+    "coordinates": "abs_time river_name",
+    "long_name": "River volume flux",
+    "units": "m^3/s"
+}

roms_tools/tests/test_setup/test_data/{grid_that_straddles_dateline.zarr/interface_depth_u → river_forcing_no_climatology.zarr/tracer_name}/.zarray

@@ -1,7 +1,5 @@
 {
     "chunks": [
-        101,
-        3,
         2
     ],
     "compressor": {
@@ -11,13 +9,11 @@
         "id": "blosc",
         "shuffle": 1
     },
-    "dtype": "<f4",
-    "fill_value": "NaN",
+    "dtype": "<U11",
+    "fill_value": null,
     "filters": null,
     "order": "C",
     "shape": [
-        101,
-        3,
         2
     ],
     "zarr_format": 2

roms_tools/tests/test_setup/test_data/river_forcing_no_climatology.zarr/tracer_name/.zattrs

@@ -0,0 +1,6 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "ntracers"
+    ],
+    "long_name": "Tracer name"
+}

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,10 +308,9 @@ def test_from_yaml_missing_initial_conditions(tmp_path, use_dask):
       center_lon: -10
       center_lat: 61
       rot: -20
-      topography_source: ETOPO5
-      smooth_factor: 8
+      topography_source:
+        name: ETOPO5
       hmin: 5.0
-      rmax: 0.2
     """
     )