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

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

@@ -4,7 +4,7 @@
     "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
     "hc": 300.0,
     "hmin": 5.0,
-    "roms_tools_version": "0.1.dev152+dirty",
+    "roms_tools_version": "0.1.dev157+dirty",
     "rot": 0,
     "size_x": 100,
     "size_y": 100,

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

@@ -6,7 +6,7 @@
             "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
             "hc": 300.0,
             "hmin": 5.0,
-            "roms_tools_version": "0.1.dev152+dirty",
+            "roms_tools_version": "0.1.dev157+dirty",
             "rot": 0,
             "size_x": 100,
             "size_y": 100,

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

@@ -4,7 +4,7 @@
     "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
     "hc": 300.0,
     "hmin": 5.0,
-    "roms_tools_version": "0.1.dev152+dirty",
+    "roms_tools_version": "0.1.dev157+dirty",
     "rot": 20,
     "size_x": 100,
     "size_y": 100,

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

@@ -6,7 +6,7 @@
             "coordinates": "interface_depth_rho interface_depth_u interface_depth_v layer_depth_rho layer_depth_u layer_depth_v",
             "hc": 300.0,
             "hmin": 5.0,
-            "roms_tools_version": "0.1.dev152+dirty",
+            "roms_tools_version": "0.1.dev157+dirty",
             "rot": 20,
             "size_x": 100,
             "size_y": 100,

roms_tools/tests/test_setup/test_datasets.py

@@ -125,9 +125,7 @@ def non_global_dataset():
     ],
 )
 def test_select_times(data_fixture, expected_time_values, request, tmp_path, use_dask):
-    """
-    Test selecting times with different datasets.
-    """
+    """Test selecting times with different datasets."""
     start_time = datetime(2022, 2, 1)
     end_time = datetime(2022, 3, 1)
 
@@ -160,9 +158,7 @@ def test_select_times(data_fixture, expected_time_values, request, tmp_path, use
 def test_select_times_valid_start_no_end_time(
     data_fixture, expected_time_values, request, tmp_path, use_dask
 ):
-    """
-    Test selecting times with only start_time specified.
-    """
+    """Test selecting times with only start_time specified."""
     start_time = datetime(2022, 2, 1)
 
     # Get the fixture dynamically based on the parameter
@@ -196,9 +192,7 @@ def test_select_times_valid_start_no_end_time(
 def test_select_times_invalid_start_no_end_time(
     data_fixture, expected_time_values, request, tmp_path, use_dask
 ):
-    """
-    Test selecting times with only start_time specified.
-    """
+    """Test selecting times with only start_time specified."""
     # Get the fixture dynamically based on the parameter
     dataset = request.getfixturevalue(data_fixture)
 
@@ -221,9 +215,8 @@ def test_select_times_invalid_start_no_end_time(
 def test_multiple_matching_times(
     global_dataset_with_multiple_times_per_day, tmp_path, use_dask
 ):
-    """
-    Test handling when multiple matching times are found when end_time is not specified.
-    """
+    """Test handling when multiple matching times are found when end_time is not
+    specified."""
     filepath = tmp_path / "test.nc"
     global_dataset_with_multiple_times_per_day.to_netcdf(filepath)
     dataset = Dataset(
@@ -237,9 +230,7 @@ def test_multiple_matching_times(
 
 
 def test_warnings_times(global_dataset, tmp_path, use_dask):
-    """
-    Test handling when no matching times are found.
-    """
+    """Test handling when no matching times are found."""
     # Create a temporary file
     filepath = tmp_path / "test.nc"
     global_dataset.to_netcdf(filepath)
@@ -271,9 +262,8 @@ def test_warnings_times(global_dataset, tmp_path, use_dask):
 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.
-    """
+    """Test reversing latitude when it is not ascending, the choose_subdomain method,
+    and the convert_to_negative_depth method of the Dataset class."""
     start_time = datetime(2022, 1, 1)
 
     filepath = tmp_path / "test.nc"

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,40 @@ 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(
@@ -162,7 +216,8 @@ def test_compatability_with_matlab_grid(tmp_path):
 
 
 def test_roundtrip_netcdf(tmp_path):
-    """Test that creating a grid, saving it to file, and re-opening it is the same as just creating it."""
+    """Test that creating a grid, saving it to file, and re-opening it is the same as
+    just creating it."""
 
     # Initialize a Grid object using the initializer
     grid_init = Grid(
@@ -199,7 +254,8 @@ def test_roundtrip_netcdf(tmp_path):
 
 
 def test_roundtrip_yaml(tmp_path):
-    """Test that creating a grid, saving its parameters to yaml file, and re-opening yaml file creates the same grid."""
+    """Test that creating a grid, saving its parameters to yaml file, and re- opening
+    yaml file creates the same grid."""
 
     # Initialize a Grid object using the initializer
     grid_init = Grid(

roms_tools/tests/test_setup/test_initial_conditions.py

@@ -19,9 +19,7 @@ from conftest import calculate_file_hash
     ],
 )
 def test_initial_conditions_creation(ic_fixture, request):
-    """
-    Test the creation of the InitialConditions object.
-    """
+    """Test the creation of the InitialConditions object."""
 
     ic = request.getfixturevalue(ic_fixture)
 
@@ -181,9 +179,7 @@ def test_interpolation_from_climatology(
 def test_initial_conditions_plot_save(
     initial_conditions_with_bgc_from_climatology, tmp_path
 ):
-    """
-    Test plot and save methods.
-    """
+    """Test plot and save methods."""
 
     initial_conditions_with_bgc_from_climatology.plot(varname="temp", s=0)
     initial_conditions_with_bgc_from_climatology.plot(
@@ -251,7 +247,8 @@ def test_initial_conditions_plot_save(
 
 
 def test_roundtrip_yaml(initial_conditions, tmp_path, use_dask):
-    """Test that creating an InitialConditions object, saving its parameters to yaml file, and re-opening yaml file creates the same object."""
+    """Test that creating an InitialConditions object, saving its parameters to yaml
+    file, and re-opening yaml file creates the same object."""
 
     # Create a temporary filepath using the tmp_path fixture
     file_str = "test_yaml"