roms-tools 1.4.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

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

@@ -1,10 +1,10 @@
 {
     "center_lat": 0,
     "center_lon": -20,
-    "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
+    "coordinates": "interface_depth_rho interface_depth_u interface_depth_v lat_psi layer_depth_rho layer_depth_u layer_depth_v lon_psi",
     "hc": 300.0,
     "hmin": 5.0,
-    "roms_tools_version": "0.1.dev152+dirty",
+    "roms_tools_version": "0.1.dev138+dirty",
     "rot": 0,
     "size_x": 100,
     "size_y": 100,

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

@@ -3,10 +3,10 @@
         ".zattrs": {
             "center_lat": 0,
             "center_lon": -20,
-            "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
+            "coordinates": "interface_depth_rho interface_depth_u interface_depth_v lat_psi layer_depth_rho layer_depth_u layer_depth_v lon_psi",
             "hc": 300.0,
             "hmin": 5.0,
-            "roms_tools_version": "0.1.dev152+dirty",
+            "roms_tools_version": "0.1.dev138+dirty",
             "rot": 0,
             "size_x": 100,
             "size_y": 100,
@@ -325,6 +325,36 @@
             "long_name": "latitude of rho-points on coarsened grid",
             "units": "degrees North"
         },
+        "lat_psi/.zarray": {
+            "chunks": [
+                4,
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f8",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                4
+            ],
+            "zarr_format": 2
+        },
+        "lat_psi/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "eta_psi",
+                "xi_psi"
+            ],
+            "long_name": "latitude of psi-points",
+            "units": "degrees North"
+        },
         "lat_rho/.zarray": {
             "chunks": [
                 3,
@@ -544,6 +574,36 @@
             "long_name": "longitude of rho-points on coarsened grid",
             "units": "degrees East"
         },
+        "lon_psi/.zarray": {
+            "chunks": [
+                4,
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f8",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                4
+            ],
+            "zarr_format": 2
+        },
+        "lon_psi/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "eta_psi",
+                "xi_psi"
+            ],
+            "long_name": "longitude of psi-points",
+            "units": "degrees East"
+        },
         "lon_rho/.zarray": {
             "chunks": [
                 3,

roms_tools/tests/test_setup/test_data/grid.zarr/lat_psi/.zarray

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

roms_tools/tests/test_setup/test_data/grid.zarr/lat_psi/.zattrs

@@ -0,0 +1,8 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "eta_psi",
+        "xi_psi"
+    ],
+    "long_name": "latitude of psi-points",
+    "units": "degrees North"
+}

roms_tools/tests/test_setup/test_data/grid.zarr/lon_psi/.zarray

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

roms_tools/tests/test_setup/test_data/grid.zarr/lon_psi/.zattrs

@@ -0,0 +1,8 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "eta_psi",
+        "xi_psi"
+    ],
+    "long_name": "longitude of psi-points",
+    "units": "degrees East"
+}

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

@@ -1,10 +1,10 @@
 {
     "center_lat": 0,
     "center_lon": 0,
-    "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
+    "coordinates": "interface_depth_rho interface_depth_u interface_depth_v lat_psi layer_depth_rho layer_depth_u layer_depth_v lon_psi",
     "hc": 300.0,
     "hmin": 5.0,
-    "roms_tools_version": "0.1.dev152+dirty",
+    "roms_tools_version": "0.1.dev138+dirty",
     "rot": 20,
     "size_x": 100,
     "size_y": 100,

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

@@ -3,10 +3,10 @@
         ".zattrs": {
             "center_lat": 0,
             "center_lon": 0,
-            "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
+            "coordinates": "interface_depth_rho interface_depth_u interface_depth_v lat_psi layer_depth_rho layer_depth_u layer_depth_v lon_psi",
             "hc": 300.0,
             "hmin": 5.0,
-            "roms_tools_version": "0.1.dev152+dirty",
+            "roms_tools_version": "0.1.dev138+dirty",
             "rot": 20,
             "size_x": 100,
             "size_y": 100,
@@ -325,6 +325,36 @@
             "long_name": "latitude of rho-points on coarsened grid",
             "units": "degrees North"
         },
+        "lat_psi/.zarray": {
+            "chunks": [
+                4,
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f8",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                4
+            ],
+            "zarr_format": 2
+        },
+        "lat_psi/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "eta_psi",
+                "xi_psi"
+            ],
+            "long_name": "latitude of psi-points",
+            "units": "degrees North"
+        },
         "lat_rho/.zarray": {
             "chunks": [
                 3,
@@ -544,6 +574,36 @@
             "long_name": "longitude of rho-points on coarsened grid",
             "units": "degrees East"
         },
+        "lon_psi/.zarray": {
+            "chunks": [
+                4,
+                4
+            ],
+            "compressor": {
+                "blocksize": 0,
+                "clevel": 5,
+                "cname": "lz4",
+                "id": "blosc",
+                "shuffle": 1
+            },
+            "dtype": "<f8",
+            "fill_value": "NaN",
+            "filters": null,
+            "order": "C",
+            "shape": [
+                4,
+                4
+            ],
+            "zarr_format": 2
+        },
+        "lon_psi/.zattrs": {
+            "_ARRAY_DIMENSIONS": [
+                "eta_psi",
+                "xi_psi"
+            ],
+            "long_name": "longitude of psi-points",
+            "units": "degrees East"
+        },
         "lon_rho/.zarray": {
             "chunks": [
                 3,

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/lat_psi/.zarray

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

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

@@ -0,0 +1,8 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "eta_psi",
+        "xi_psi"
+    ],
+    "long_name": "latitude of psi-points",
+    "units": "degrees North"
+}

roms_tools/tests/test_setup/test_data/grid_that_straddles_dateline.zarr/lon_psi/.zarray

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

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

@@ -0,0 +1,8 @@
+{
+    "_ARRAY_DIMENSIONS": [
+        "eta_psi",
+        "xi_psi"
+    ],
+    "long_name": "longitude of psi-points",
+    "units": "degrees East"
+}

roms_tools/tests/test_setup/test_grid.py

@@ -8,6 +8,26 @@ from conftest import calculate_file_hash
 from pathlib import Path
 
 
+@pytest.fixture()
+def counter_clockwise_rotated_grid():
+
+    grid = Grid(
+        nx=1, ny=1, size_x=100, size_y=100, center_lon=-20, center_lat=0, rot=20
+    )
+
+    return grid
+
+
+@pytest.fixture()
+def clockwise_rotated_grid():
+
+    grid = Grid(
+        nx=1, ny=1, size_x=100, size_y=100, center_lon=-20, center_lat=0, rot=-20
+    )
+
+    return grid
+
+
 def test_grid_creation(grid):
 
     assert grid.nx == 1
@@ -20,6 +40,42 @@ def test_grid_creation(grid):
     assert isinstance(grid.ds, xr.Dataset)
 
 
+@pytest.mark.parametrize(
+    "grid_fixture",
+    ["grid", "counter_clockwise_rotated_grid", "clockwise_rotated_grid"],
+)
+def test_coords_relation(grid_fixture, request):
+    """
+    Test that the coordinates satisfy the expected relations on a C-grid.
+    """
+    grid = request.getfixturevalue(grid_fixture)
+
+    # psi versus rho
+    assert grid.ds.lon_psi.min() < grid.ds.lon_rho.min()
+    assert grid.ds.lon_psi.max() > grid.ds.lon_rho.max()
+    assert grid.ds.lat_psi.min() < grid.ds.lat_rho.min()
+    assert grid.ds.lat_psi.max() > grid.ds.lat_rho.max()
+
+    # Assertion with tolerance is necessary for non-rotated grids
+    def assert_larger_equal_than_with_tolerance(value1, value2, tolerance=1e-5):
+        assert value1 >= value2 - tolerance
+
+    def assert_smaller_equal_than_with_tolerance(value1, value2, tolerance=1e-5):
+        assert value1 <= value2 + tolerance
+
+    # u versus rho
+    assert_larger_equal_than_with_tolerance(grid.ds.lon_u.min(), grid.ds.lon_rho.min())
+    assert_larger_equal_than_with_tolerance(grid.ds.lat_u.min(), grid.ds.lat_rho.min())
+    assert_smaller_equal_than_with_tolerance(grid.ds.lon_u.max(), grid.ds.lon_rho.max())
+    assert_smaller_equal_than_with_tolerance(grid.ds.lon_u.max(), grid.ds.lon_rho.max())
+
+    # v versus rho
+    assert_larger_equal_than_with_tolerance(grid.ds.lon_v.min(), grid.ds.lon_rho.min())
+    assert_larger_equal_than_with_tolerance(grid.ds.lat_v.min(), grid.ds.lat_rho.min())
+    assert_smaller_equal_than_with_tolerance(grid.ds.lon_v.max(), grid.ds.lon_rho.max())
+    assert_smaller_equal_than_with_tolerance(grid.ds.lon_v.max(), grid.ds.lon_rho.max())
+
+
 def test_plot_save_methods(tmp_path):
 
     grid = Grid(

roms_tools/tests/test_setup/test_surface_forcing.py

@@ -13,8 +13,8 @@ def grid_that_straddles_dateline():
     Fixture for creating a domain that straddles the dateline and lies within the bounds of the regional ERA5 data.
     """
     grid = Grid(
-        nx=5,
-        ny=5,
+        nx=20,
+        ny=20,
         size_x=1800,
         size_y=2400,
         center_lon=-10,