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

roms_tools/tests/test_tides.py

@@ -4,7 +4,7 @@ import os
 from roms_tools import Grid, TidalForcing
 import xarray as xr
 import numpy as np
-from roms_tools.setup.datasets import download_test_data
+from roms_tools.setup.download import download_test_data
 import textwrap
 
 
@@ -76,7 +76,9 @@ def test_successful_initialization_with_global_data(grid_fixture, request):
 
     grid = request.getfixturevalue(grid_fixture)
 
-    tidal_forcing = TidalForcing(grid=grid, filename=fname, source="TPXO", ntides=2)
+    tidal_forcing = TidalForcing(
+        grid=grid, source={"name": "TPXO", "path": fname}, ntides=2
+    )
 
     assert isinstance(tidal_forcing.ds, xr.Dataset)
     assert "omega" in tidal_forcing.ds
@@ -89,8 +91,7 @@ def test_successful_initialization_with_global_data(grid_fixture, request):
     assert "v_Re" in tidal_forcing.ds
     assert "v_Im" in tidal_forcing.ds
 
-    assert tidal_forcing.filename == fname
-    assert tidal_forcing.source == "TPXO"
+    assert tidal_forcing.source == {"name": "TPXO", "path": fname}
     assert tidal_forcing.ntides == 2
 
 
@@ -102,8 +103,7 @@ def test_successful_initialization_with_regional_data(
 
     tidal_forcing = TidalForcing(
         grid=grid_that_lies_within_bounds_of_regional_tpxo_data,
-        filename=fname,
-        source="TPXO",
+        source={"name": "TPXO", "path": fname},
         ntides=10,
     )
 
@@ -118,8 +118,7 @@ def test_successful_initialization_with_regional_data(
     assert "v_Re" in tidal_forcing.ds
     assert "v_Im" in tidal_forcing.ds
 
-    assert tidal_forcing.filename == fname
-    assert tidal_forcing.source == "TPXO"
+    assert tidal_forcing.source == {"name": "TPXO", "path": fname}
     assert tidal_forcing.ntides == 10
 
 
@@ -132,8 +131,7 @@ def test_unsuccessful_initialization_with_regional_data_due_to_nans(
     with pytest.raises(ValueError, match="NaN values found"):
         TidalForcing(
             grid=grid_that_is_out_of_bounds_of_regional_tpxo_data,
-            filename=fname,
-            source="TPXO",
+            source={"name": "TPXO", "path": fname},
             ntides=10,
         )
 
@@ -153,7 +151,7 @@ def test_unsuccessful_initialization_with_regional_data_due_to_no_overlap(
     with pytest.raises(
         ValueError, match="Selected longitude range does not intersect with dataset"
     ):
-        TidalForcing(grid=grid, filename=fname, source="TPXO", ntides=10)
+        TidalForcing(grid=grid, source={"name": "TPXO", "path": fname}, ntides=10)
 
 
 def test_insufficient_number_of_consituents(grid_that_straddles_dateline):
@@ -162,7 +160,9 @@ def test_insufficient_number_of_consituents(grid_that_straddles_dateline):
 
     with pytest.raises(ValueError, match="The dataset contains fewer"):
         TidalForcing(
-            grid=grid_that_straddles_dateline, filename=fname, source="TPXO", ntides=10
+            grid=grid_that_straddles_dateline,
+            source={"name": "TPXO", "path": fname},
+            ntides=10,
         )
 
 
@@ -175,8 +175,7 @@ def tidal_forcing(
 
     return TidalForcing(
         grid=grid_that_lies_within_bounds_of_regional_tpxo_data,
-        filename=fname,
-        source="TPXO",
+        source={"name": "TPXO", "path": fname},
         ntides=1,
     )
 

roms_tools/tests/test_utils.py

@@ -0,0 +1,16 @@
+from roms_tools.setup.utils import interpolate_from_climatology
+from roms_tools.setup.datasets import ERA5Correction
+from roms_tools.setup.download import download_test_data
+import xarray as xr
+
+
+def test_interpolate_from_climatology():
+
+    fname = download_test_data("ERA5_regional_test_data.nc")
+    era5_times = xr.open_dataset(fname).time
+
+    climatology = ERA5Correction()
+    field = climatology.ds["ssr_corr"]
+
+    interpolated_field = interpolate_from_climatology(field, "time", era5_times)
+    assert len(interpolated_field.time) == len(era5_times)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 0.20
+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,9 +32,12 @@ Requires-Dist: numba
 
 # ROMS-Tools
 
+[![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)
-[![PyPI version](https://badge.fury.io/py/roms-tools.svg)](https://badge.fury.io/py/roms-tools)
+![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
 

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.20.dist-info → roms_tools-1.0.0.dist-info}/WHEEL

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