roms-tools 2.0.0__tar.gz → 2.1.0__tar.gz

roms_tools-2.1.0/.github/PULL_RELEASE_TEMPLATE.md

@@ -0,0 +1,8 @@
+<!-- Feel free to remove check-list items aren't relevant to your change -->
+
+- [ ] Closes #xxxx
+- [ ] Tests added
+- [ ] Tests passing
+- [ ] Changes are documented in `docs/releases.md`
+- [ ] New functions/methods are listed in `docs/api.rst`
+- [ ] New functionality has documentation

roms_tools-2.1.0/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+<!-- Feel free to remove check-list items aren't relevant to your change -->
+
+- [ ] Closes #xxxx
+- [ ] Tests added
+- [ ] Passes `pre-commit run --all-files`
+- [ ] Changes are documented in `docs/releases.md`
+- [ ] New functions/methods are listed in `docs/api.rst`
+- [ ] New functionality has documentation

{roms_tools-2.0.0 → roms_tools-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 2.0.0
+Version: 2.1.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
@@ -43,12 +43,16 @@ Requires-Dist: dask[diagnostics]; extra == "dask"
 ![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)
 
+> [!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.
+> 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.
-
-<mark>**DISCLAIMER**: This project is **ALPHA** and will be **EXPERIMENTAL** at least throughout 2024. We do not recommend to use this software before this ALPHA development and test phase is completed.</mark>
+A suite of Python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
 
 ## Installation
 

{roms_tools-2.0.0 → roms_tools-2.1.0}/README.md

@@ -6,12 +6,16 @@
 ![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)
 
+> [!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.
+> 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.
-
-<mark>**DISCLAIMER**: This project is **ALPHA** and will be **EXPERIMENTAL** at least throughout 2024. We do not recommend to use this software before this ALPHA development and test phase is completed.</mark>
+A suite of Python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
 
 ## Installation
 

{roms_tools-2.0.0 → roms_tools-2.1.0}/conftest.py

@@ -423,6 +423,21 @@ def river_forcing_no_climatology():
     )
 
 
+@pytest.fixture
+def river_forcing_with_bgc(scope="session"):
+    """Fixture for creating a RiverForcing object with BGC tracers."""
+    grid = Grid(
+        nx=18, ny=18, size_x=800, size_y=800, center_lon=-18, center_lat=65, rot=20, N=3
+    )
+
+    start_time = datetime(1998, 1, 1)
+    end_time = datetime(1998, 3, 1)
+
+    return RiverForcing(
+        grid=grid, start_time=start_time, end_time=end_time, include_bgc=True
+    )
+
+
 @pytest.fixture(scope="session")
 def era5_data(request, use_dask):
     fname = download_test_data("ERA5_regional_test_data.nc")

{roms_tools-2.0.0 → roms_tools-2.1.0}/docs/api.rst

@@ -42,6 +42,22 @@ Boundary Forcing
 
    roms_tools.BoundaryForcing
 
+River Forcing
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.RiverForcing
+
+Nesting
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.Nesting
+
 =======
 
 Utilities