roms-tools 2.4.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

roms_tools/tests/test_setup/test_surface_forcing.py

@@ -351,6 +351,53 @@ def test_successful_initialization_with_global_data(grid_fixture, request, use_d
             assert not sfc_forcing.use_coarse_grid
 
 
+def test_start_time_end_time_error(use_dask):
+    """Test error when start_time and end_time are not both provided or both None."""
+    # Case 1: Only start_time provided
+    with pytest.raises(
+        ValueError, match="Both `start_time` and `end_time` must be provided together"
+    ):
+        SurfaceForcing(
+            grid=None,
+            start_time=datetime(2022, 1, 1),
+            end_time=None,  # end_time is None, should raise an error
+            source={"name": "ERA5", "path": "era5_data.nc"},
+            use_dask=use_dask,
+        )
+
+    # Case 2: Only end_time provided
+    with pytest.raises(
+        ValueError, match="Both `start_time` and `end_time` must be provided together"
+    ):
+        SurfaceForcing(
+            grid=None,
+            start_time=None,  # start_time is None, should raise an error
+            end_time=datetime(2022, 1, 2),
+            source={"name": "ERA5", "path": "era5_data.nc"},
+            use_dask=use_dask,
+        )
+
+
+def test_start_time_end_time_warning(grid_that_straddles_dateline, use_dask, caplog):
+    """Test that a warning is triggered when both start_time and end_time are None."""
+    fname = Path(download_test_data("ERA5_regional_test_data.nc"))
+
+    with caplog.at_level(logging.INFO):
+        SurfaceForcing(
+            grid=grid_that_straddles_dateline,
+            start_time=None,
+            end_time=None,
+            source={"name": "ERA5", "path": fname},
+            use_dask=use_dask,
+        )
+
+    # Verify the warning message in the log
+    assert (
+        "Both `start_time` and `end_time` are None. No time filtering will be applied to the source data."
+        in caplog.text
+    )
+
+
 def test_nans_filled_in(grid_that_straddles_dateline, use_dask):
     """Test that the surface forcing fields contain no NaNs.
 

roms_tools/tests/test_setup/test_validation.py

@@ -70,7 +70,39 @@ def test_check_results(forcing_fixture, request):
 
     fname = _get_fname(forcing_fixture)
     expected_forcing_ds = xr.open_zarr(fname, decode_timedelta=False)
-
     forcing = request.getfixturevalue(forcing_fixture)
 
-    xr.testing.assert_allclose(forcing.ds, expected_forcing_ds, rtol=1.0e-5)
+    xr.testing.assert_allclose(forcing.ds, expected_forcing_ds, rtol=1.0e-5, atol=1e-08)
+
+
+@pytest.mark.parametrize(
+    "forcing_fixture",
+    [
+        "tidal_forcing",
+        "initial_conditions_with_bgc_from_climatology",
+        "surface_forcing",
+        "coarse_surface_forcing",
+        "corrected_surface_forcing",
+        "bgc_surface_forcing",
+        "bgc_surface_forcing_from_climatology",
+        "boundary_forcing",
+        "bgc_boundary_forcing_from_climatology",
+    ],
+)
+def test_dask_vs_no_dask(forcing_fixture, request, tmp_path, use_dask):
+    """Test comparing the forcing created with and without Dask on same platform."""
+
+    if not use_dask:
+        pytest.skip("Test only runs when --use_dask is specified")
+
+    # Get the forcing with Dask
+    forcing_with_dask = request.getfixturevalue(forcing_fixture)
+
+    filepath = tmp_path / "test.yaml"
+    forcing_with_dask.to_yaml(filepath)
+
+    # Get the forcing without Dask
+    forcing_without_dask = type(forcing_with_dask).from_yaml(filepath, use_dask=False)
+
+    # Compare the two datasets using assert_equal (only within the same platform)
+    xr.testing.assert_equal(forcing_with_dask.ds, forcing_without_dask.ds)

roms_tools/utils.py

@@ -3,6 +3,7 @@ from pathlib import Path
 import re
 import glob
 import logging
+import warnings
 
 
 def _load_data(
@@ -139,13 +140,16 @@ def _load_data(
         if "time" in dim_names and time_chunking:
             chunks[dim_names["time"]] = 1
 
-        ds = xr.open_mfdataset(
-            matching_files,
-            decode_times=decode_times,
-            chunks=chunks,
-            **combine_kwargs,
-            **kwargs,
-        )
+        with warnings.catch_warnings():
+            warnings.filterwarnings("ignore", category=UserWarning, module="xarray")
+
+            ds = xr.open_mfdataset(
+                matching_files,
+                decode_times=decode_times,
+                chunks=chunks,
+                **combine_kwargs,
+                **kwargs,
+            )
 
         # Rechunk the dataset along the tidal constituent dimension ("ntides") after loading
         # because the original dataset does not have a chunk size of 1 along this dimension.

roms_tools/vertical_coordinate.py

@@ -220,6 +220,7 @@ def compute_depth_coordinates(
     depth = compute_depth(zeta, h, grid_ds.attrs["hc"], Cs, sigma)
 
     # Add metadata
+    depth.name = f"{depth_type}_depth_{location}"
     depth.attrs.update(
         {"long_name": f"{depth_type} depth at {location}-points", "units": "m"}
     )

{roms_tools-2.4.0.dist-info → roms_tools-2.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: roms-tools
-Version: 2.4.0
+Version: 2.6.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
@@ -32,8 +32,11 @@ Requires-Dist: PyYAML
 Requires-Dist: pyamg
 Requires-Dist: bottleneck
 Requires-Dist: regionmask
+Requires-Dist: xgcm
+Requires-Dist: numba
 Provides-Extra: dask
 Requires-Dist: dask[diagnostics]; extra == "dask"
+Dynamic: license-file
 
 # ROMS-Tools
 [![Conda version](https://img.shields.io/conda/vn/conda-forge/roms-tools.svg)](https://anaconda.org/conda-forge/roms-tools)
@@ -46,37 +49,45 @@ Requires-Dist: dask[diagnostics]; extra == "dask"
 > [!Warning]
 > **This project is still in an early phase of development.**
 >
-> The [python API](https://roms-tools.readthedocs.io/en/latest/api.html) is not yet stable.
+> The [Python API](https://roms-tools.readthedocs.io/en/latest/api.html) is not yet stable.
 > Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility.
 > We expect to reach a more stable version in Q1 2025.
 
 ## Overview
 
-A suite of Python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
+A suite of Python tools for setting up and analyzing a [UCLA-ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
 
 ## Installation
 
-### Installation from conda forge
+### ⚡️ **Installation from Conda-Forge**
+
+To install `ROMS-Tools` with all dependencies, including `xesmf` and `dask`, use:
 
 ```bash
 conda install -c conda-forge roms-tools
 ```
 
-This command installs `ROMS-Tools` along with its `dask` dependency.
+> [!Note]
+>  Installation from Conda-Forge is the recommended installation method to ensure all features of `ROMS-Tools` are available.
+
+### 📦 **Installation from PyPI (pip)**
 
-### Installation from pip
+You can also install `ROMS-Tools` from `pip`:
 
 ```bash
 pip install roms-tools
 ```
 
-If you want to use `ROMS-Tools` together with dask (which we recommend), you can
-install `ROMS-Tools` along with the additional dependency via:
+If you want to use `ROMS-Tools` with `dask` (recommended for parallel and out-of-core computation), install it with the additional dependency:
 
 ```bash
 pip install roms-tools[dask]
 ```
 
+> [!Note]
+>  The PyPI versions of `ROMS-Tools` do not include `xesmf`, so some features will be unavailable.
+
+
 ### Installation from GitHub
 
 To obtain the latest development version, first clone the source repository:
@@ -89,7 +100,7 @@ cd roms-tools
 Next, install and activate the following conda environment:
 
 ```bash
-conda env create -f ci/environment.yml
+conda env create -f ci/environment-with-xesmf.yml
 conda activate romstools-test
 ```
 
@@ -99,7 +110,7 @@ Finally, install `ROMS-Tools` in the same environment:
 pip install -e .
 ```
 
-If you want to use `ROMS-Tools` together with dask (which we recommend), you can
+If you want to use `ROMS-Tools` with `dask` (recommended for parallel and out-of-core computation), you can
 install `ROMS-Tools` along with the additional dependency via:
 
 ```bash