roms-tools 0.1.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

roms_tools/tests/test_vertical_coordinate.py

@@ -0,0 +1,337 @@
+import pytest
+import numpy as np
+import tempfile
+import os
+from roms_tools import Grid, VerticalCoordinate
+import textwrap
+
+
+@pytest.fixture
+def example_grid():
+    """
+    Fixture for creating a Grid object.
+    """
+    grid = Grid(
+        nx=2, ny=2, size_x=500, size_y=1000, center_lon=0, center_lat=55, rot=10
+    )
+
+    return grid
+
+
+def test_invalid_theta_s_value(example_grid):
+    """
+    Test the validation of the theta_s value.
+    """
+    with pytest.raises(ValueError):
+
+        VerticalCoordinate(
+            grid=example_grid,
+            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(example_grid):
+    """
+    Test the validation of the theta_b value.
+    """
+    with pytest.raises(ValueError):
+
+        VerticalCoordinate(
+            grid=example_grid,
+            N=3,
+            theta_s=5.0,
+            theta_b=5.0,  # Invalid value, should be 0 < theta_b <= 4
+            hc=250.0,
+        )
+
+
+@pytest.fixture
+def vertical_coordinate(example_grid):
+
+    return VerticalCoordinate(
+        grid=example_grid, N=3, theta_s=5.0, theta_b=2.0, hc=250.0
+    )
+
+
+def test_vertical_coordinate_data_consistency(vertical_coordinate, tmp_path):
+    """
+    Test that the data within the VerticalCoordinate object remains consistent.
+    """
+
+    # Define the expected data
+    expected_sc_r = np.array([-0.8333333, -0.5, -0.16666667], dtype=np.float32)
+    expected_Cs_r = np.array([-0.6641397, -0.15129805, -0.01156188], dtype=np.float32)
+    expected_layer_depth_rho = np.array(
+        [
+            [
+                [17.235603, 9.938617, 3.2495391],
+                [17.235603, 9.938617, 3.2495391],
+                [24.206884, 13.7451725, 4.4592304],
+                [24.206884, 13.7451725, 4.4592304],
+            ],
+            [
+                [17.235603, 9.938617, 3.2495391],
+                [17.235603, 9.938617, 3.2495391],
+                [24.206884, 13.7451725, 4.4592304],
+                [24.206884, 13.7451725, 4.4592304],
+            ],
+            [
+                [25.667452, 14.528268, 4.7055993],
+                [25.667452, 14.528268, 4.7055993],
+                [35.966946, 19.916193, 6.377065],
+                [35.966946, 19.916193, 6.377065],
+            ],
+            [
+                [25.667452, 14.528268, 4.7055993],
+                [25.667452, 14.528268, 4.7055993],
+                [35.966946, 19.916193, 6.377065],
+                [35.966946, 19.916193, 6.377065],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    expected_layer_depth_u = np.array(
+        [
+            [
+                [17.235603, 9.938617, 3.2495391],
+                [20.721243, 11.841895, 3.854385],
+                [24.206884, 13.7451725, 4.4592304],
+            ],
+            [
+                [17.235603, 9.938617, 3.2495391],
+                [20.721243, 11.841895, 3.854385],
+                [24.206884, 13.7451725, 4.4592304],
+            ],
+            [
+                [25.667452, 14.528268, 4.7055993],
+                [30.817198, 17.22223, 5.5413322],
+                [35.966946, 19.916193, 6.377065],
+            ],
+            [
+                [25.667452, 14.528268, 4.7055993],
+                [30.817198, 17.22223, 5.5413322],
+                [35.966946, 19.916193, 6.377065],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    expected_layer_depth_v = np.array(
+        [
+            [
+                [17.235603, 9.938617, 3.2495391],
+                [17.235603, 9.938617, 3.2495391],
+                [24.206884, 13.7451725, 4.4592304],
+                [24.206884, 13.7451725, 4.4592304],
+            ],
+            [
+                [21.451529, 12.233442, 3.977569],
+                [21.451529, 12.233442, 3.977569],
+                [30.086914, 16.830683, 5.418148],
+                [30.086914, 16.830683, 5.418148],
+            ],
+            [
+                [25.667452, 14.528268, 4.7055993],
+                [25.667452, 14.528268, 4.7055993],
+                [35.966946, 19.916193, 6.377065],
+                [35.966946, 19.916193, 6.377065],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    expected_interface_depth_rho = np.array(
+        [
+            [
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+            ],
+            [
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+            ],
+            [
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+            ],
+            [
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    expected_interface_depth_u = np.array(
+        [
+            [
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [25.350803, 16.13514, 7.78195, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+            ],
+            [
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [25.350803, 16.13514, 7.78195, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+            ],
+            [
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [38.022217, 23.705446, 11.239724, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+            ],
+            [
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [38.022217, 23.705446, 11.239724, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    expected_interface_depth_v = np.array(
+        [
+            [
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [21.013529, 13.487298, 6.5489607, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+                [29.688076, 18.78298, 9.014939, -0.0],
+            ],
+            [
+                [26.26544, 16.684502, 8.034093, -0.0],
+                [26.26544, 16.684502, 8.034093, -0.0],
+                [37.10758, 23.156084, 10.987581, -0.0],
+                [37.10758, 23.156084, 10.987581, -0.0],
+            ],
+            [
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [31.51735, 19.881702, 9.519225, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+                [44.52708, 27.529188, 12.960222, -0.0],
+            ],
+        ],
+        dtype=np.float32,
+    )
+    # Check the values in the dataset
+    assert np.allclose(vertical_coordinate.ds["sc_r"].values, expected_sc_r)
+    assert np.allclose(vertical_coordinate.ds["Cs_r"].values, expected_Cs_r)
+    assert np.allclose(
+        vertical_coordinate.ds["layer_depth_rho"].values, expected_layer_depth_rho
+    )
+    assert np.allclose(
+        vertical_coordinate.ds["layer_depth_u"].values, expected_layer_depth_u
+    )
+    assert np.allclose(
+        vertical_coordinate.ds["layer_depth_v"].values, expected_layer_depth_v
+    )
+    assert np.allclose(
+        vertical_coordinate.ds["interface_depth_rho"].values,
+        expected_interface_depth_rho,
+    )
+    assert np.allclose(
+        vertical_coordinate.ds["interface_depth_u"].values, expected_interface_depth_u
+    )
+    assert np.allclose(
+        vertical_coordinate.ds["interface_depth_v"].values, expected_interface_depth_v
+    )
+
+
+def test_plot(vertical_coordinate):
+    vertical_coordinate.plot("layer_depth_u", s=0)
+    vertical_coordinate.plot("layer_depth_rho", s=-1)
+    vertical_coordinate.plot("interface_depth_v", s=-1)
+    vertical_coordinate.plot("layer_depth_rho", eta=0)
+    vertical_coordinate.plot("layer_depth_u", eta=0)
+    vertical_coordinate.plot("layer_depth_v", eta=0)
+    vertical_coordinate.plot("interface_depth_rho", eta=0)
+    vertical_coordinate.plot("interface_depth_u", eta=0)
+    vertical_coordinate.plot("interface_depth_v", eta=0)
+    vertical_coordinate.plot("layer_depth_rho", xi=0)
+    vertical_coordinate.plot("layer_depth_u", xi=0)
+    vertical_coordinate.plot("layer_depth_v", xi=0)
+    vertical_coordinate.plot("interface_depth_rho", xi=0)
+    vertical_coordinate.plot("interface_depth_u", xi=0)
+    vertical_coordinate.plot("interface_depth_v", xi=0)
+
+
+def test_save(vertical_coordinate, tmp_path):
+    filepath = tmp_path / "vertical_coordinate.nc"
+    vertical_coordinate.save(filepath)
+    assert filepath.exists()
+
+
+def test_roundtrip(vertical_coordinate):
+    """Test that creating a vertical_coordinate, saving it to file, and re-opening it is the same as just creating it."""
+
+    # Create a temporary file
+    with tempfile.NamedTemporaryFile(delete=False) as tmpfile:
+        filepath = tmpfile.name
+
+    try:
+        vertical_coordinate.save(filepath)
+
+        vertical_coordinate_from_file = VerticalCoordinate.from_file(filepath)
+
+        assert vertical_coordinate.ds == vertical_coordinate_from_file.ds
+
+    finally:
+        os.remove(filepath)
+
+
+def test_roundtrip_yaml(vertical_coordinate):
+    """Test that creating a VerticalCoordinate object, saving its parameters to yaml file, and re-opening yaml file creates the same object."""
+
+    # Create a temporary file
+    with tempfile.NamedTemporaryFile(delete=False) as tmpfile:
+        filepath = tmpfile.name
+
+    try:
+        vertical_coordinate.to_yaml(filepath)
+
+        vertical_coordinate_from_file = VerticalCoordinate.from_yaml(filepath)
+
+        assert vertical_coordinate == vertical_coordinate_from_file
+
+    finally:
+        os.remove(filepath)
+
+
+def test_from_yaml_missing_vertical_coordinate():
+    yaml_content = textwrap.dedent(
+        """\
+    ---
+    roms_tools_version: 0.0.0
+    ---
+    Grid:
+      nx: 100
+      ny: 100
+      size_x: 1800
+      size_y: 2400
+      center_lon: -10
+      center_lat: 61
+      rot: -20
+      topography_source: ETOPO5
+      smooth_factor: 8
+      hmin: 5.0
+      rmax: 0.2
+    """
+    )
+
+    with tempfile.NamedTemporaryFile(delete=False) as tmp_file:
+        yaml_filepath = tmp_file.name
+        tmp_file.write(yaml_content.encode())
+
+    try:
+        with pytest.raises(
+            ValueError,
+            match="No VerticalCoordinate configuration found in the YAML file.",
+        ):
+            VerticalCoordinate.from_yaml(yaml_filepath)
+    finally:
+        os.remove(yaml_filepath)

{roms_tools-0.1.0.dist-info → roms_tools-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 0.1.0
+Version: 1.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
@@ -18,7 +18,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: xarray >=2022.6.0
+Requires-Dist: xarray>=2022.6.0
+Requires-Dist: xarray-datatree
 Requires-Dist: numpy
 Requires-Dist: netcdf4
 Requires-Dist: pooch
@@ -31,8 +32,12 @@ Requires-Dist: numba
 
 # ROMS-Tools
 
-[![Documentation Status](https://readthedocs.org/projects/roms-tools/badge/?version=latest)](https://roms-tools.readthedocs.io/en/latest/?badge=latest)
 [![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
+[![codecov](https://codecov.io/gh/CWorthy-ocean/roms-tools/graph/badge.svg?token=5S1oNu39xE)](https://codecov.io/gh/CWorthy-ocean/roms-tools)
+[![Documentation Status](https://readthedocs.org/projects/roms-tools/badge/?version=latest)](https://roms-tools.readthedocs.io/en/latest/?badge=latest)
+![Run Tests](https://github.com/CWorthy-ocean/roms-tools/actions/workflows/tests.yaml/badge.svg)
+![Supported Python Versions](https://img.shields.io/pypi/pyversions/roms-tools)
+
 
 ## Overview
 
@@ -59,7 +64,7 @@ pip install -e .
 
 ### Run the tests
 
-Before running the tests you can install and activate the following conda environment:
+Before running the tests, you can install and activate the following conda environment:
 
 ```bash
 cd roms-tools

roms_tools-1.0.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+ci/environment.yml,sha256=tjoIEUdPWfJBO4ijsJYhq7ay8_QfJKxRtq8Z0r8rHTI,427
+roms_tools/__init__.py,sha256=v0fXc7jON8jbXD1zIxuC5dEqIa30PkMzTVe0bLGMrhY,642
+roms_tools/_version.py,sha256=TDFyBsBYj5dQ4UQBcf-o9xaD5eD4cemY65tpAOJYk5Y,72
+roms_tools/setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roms_tools/setup/boundary_forcing.py,sha256=ulif6YOZX-RzoJ-HotNlWSb3z3g-7E2qIR_mzv-F8Q4,33179
+roms_tools/setup/datasets.py,sha256=3PJ0JCQUcNVHd4Xl7dodJ6lZJmV5cRkCxH-vOuZtrZ4,41478
+roms_tools/setup/download.py,sha256=SapK5GIx-ykBrqqj0S_dgMxBBDGVKTfgIdbaiiOohhY,4280
+roms_tools/setup/fill.py,sha256=45Ro5oN-n-n_qKZq3qTHn27ZKpTKWhr_9AWw6gUJ-9I,13291
+roms_tools/setup/grid.py,sha256=V3vVOrkmlHM4CfhIGGlGTCw2OvZ62MGnrUHJepDylsA,30848
+roms_tools/setup/initial_conditions.py,sha256=CzoGLzQiJKRw2V_HChX3XACJU-2uEVD279H_b2PvfIw,21588
+roms_tools/setup/mixins.py,sha256=EDaIbRCPVE2aJkGekh99sAeiSmyl-SUMfiTaCcHGVyg,16808
+roms_tools/setup/plot.py,sha256=vpOoAHE5HvnmeAPyhr-GijGLLlqkEple5hfr_f3Nfn8,6331
+roms_tools/setup/surface_forcing.py,sha256=fZGn93qzPgCJNKPUSjZH3rIfVL2nqXr4OJ7YtR5Tzro,22143
+roms_tools/setup/tides.py,sha256=PP-R4mqMI_RpVOAg0hH3dAAaUjB6C3rSR_JyvJ1zODw,22907
+roms_tools/setup/topography.py,sha256=yNJn9KW9m7UB6nxh5bUQzllt6z22AQahUwWIIUwHz_Y,8557
+roms_tools/setup/utils.py,sha256=6_rNPWSP1Q5PjRlMAKS3GunBWySzPcnj6xYAFaFbqfY,12678
+roms_tools/setup/vertical_coordinate.py,sha256=IqZN3vDW4DyeaQSr-Di5O8qH2cLJE__XKmf4lROgF8s,16122
+roms_tools/tests/test_boundary_forcing.py,sha256=wLhX9UOZ6cfR-c3gw7bvM6ttwMCH8LpZlqXlLrQsvWM,24438
+roms_tools/tests/test_datasets.py,sha256=RPpnKa4kUrXgCUCc3ca7SdHnFs7qQmOwQYQnPEN6T_g,11743
+roms_tools/tests/test_grid.py,sha256=Dhci5NXOQsASM9mdNCmqyxVXcSasjjlNvcYxKZoah6E,5587
+roms_tools/tests/test_initial_conditions.py,sha256=xY-QkpGUEMeO1R076Ww0bSa3p8-qtTLVl1bTFUrv7kw,16701
+roms_tools/tests/test_surface_forcing.py,sha256=CBLOOuA0LxLQwyedbN0idtnl2wVjT5mDq4nR5LH1DxA,78007
+roms_tools/tests/test_tides.py,sha256=wcH8WAvzb-FqJmr_VLTwldV8XalyntZANhy-FRMQ7e4,11133
+roms_tools/tests/test_topography.py,sha256=Nwzor5ciOZfV7Y7fDazE1JH1qxotmJilOpZUcHxAypI,1945
+roms_tools/tests/test_utils.py,sha256=Ey5jrsdd7B9kL5ijqr9CLQNguPlxVMTybIneihdefN8,560
+roms_tools/tests/test_vertical_coordinate.py,sha256=GshM5l1e9bl4RT0HATQJg9YJ9asGK4beqIKbZxr9j7U,10843
+roms_tools-1.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+roms_tools-1.0.0.dist-info/METADATA,sha256=gi-rdZeU47LyWqXw-Xn_KrYpteCjYqVlmQz9lNLccAA,2918
+roms_tools-1.0.0.dist-info/WHEEL,sha256=nCVcAvsfA9TDtwGwhYaRrlPhTLV9m-Ga6mdyDtuwK18,91
+roms_tools-1.0.0.dist-info/top_level.txt,sha256=aAf4T4nYQSkay5iKJ9kmTjlDgd4ETdp9OSlB4sJdt8Y,19
+roms_tools-1.0.0.dist-info/RECORD,,

{roms_tools-0.1.0.dist-info → roms_tools-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (73.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any