roms-tools 3.4.0__tar.gz → 3.5.0__tar.gz

{roms_tools-3.4.0 → roms_tools-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: roms-tools
-Version: 3.4.0
+Version: 3.5.0
 Summary: Tools for running and analysing UCLA-ROMS simulations
 Author-email: Nora Loose <nora.loose@gmail.com>, Thomas Nicholas <tom@cworthy.org>, Scott Eilerman <scott.eilerman@cworthy.org>
 License: Apache-2
@@ -64,7 +64,7 @@ Dynamic: license-file
 
 ## Overview
 
-A suite of Python tools for setting up and analyzing a [UCLA-ROMS](https://github.com/CESR-lab/ucla-roms) simulation with or without [MARBL biogeochemistry](https://marbl-ecosys.github.io/versions/latest_release/index.html).
+A suite of Python tools for setting up and analyzing a [UCLA-ROMS](https://github.com/CWorthy-ocean/ucla-roms) simulation with or without [MARBL biogeochemistry](https://marbl-ecosys.github.io/versions/latest_release/index.html).
 
 ## Installation
 
@@ -152,5 +152,4 @@ We also accept contributions in the form of Pull Requests.
 
 ## See also
 
-- [ROMS source code](https://github.com/CESR-lab/ucla-roms)
 - [C-Star](https://github.com/CWorthy-ocean/C-Star)

{roms_tools-3.4.0 → roms_tools-3.5.0}/README.md

@@ -10,7 +10,7 @@
 
 ## Overview
 
-A suite of Python tools for setting up and analyzing a [UCLA-ROMS](https://github.com/CESR-lab/ucla-roms) simulation with or without [MARBL biogeochemistry](https://marbl-ecosys.github.io/versions/latest_release/index.html).
+A suite of Python tools for setting up and analyzing a [UCLA-ROMS](https://github.com/CWorthy-ocean/ucla-roms) simulation with or without [MARBL biogeochemistry](https://marbl-ecosys.github.io/versions/latest_release/index.html).
 
 ## Installation
 
@@ -98,5 +98,4 @@ We also accept contributions in the form of Pull Requests.
 
 ## See also
 
-- [ROMS source code](https://github.com/CESR-lab/ucla-roms)
 - [C-Star](https://github.com/CWorthy-ocean/C-Star)

{roms_tools-3.4.0 → roms_tools-3.5.0}/conftest.py

@@ -431,6 +431,45 @@ def initial_conditions_with_unified_bgc_from_climatology(
     )
 
 
+@pytest.fixture(scope="session")
+def initial_conditions_from_roms(
+    use_dask: bool,
+) -> InitialConditions:
+    grid = Grid(nx=5, ny=5, center_lon=-120, center_lat=34, size_x=100, size_y=100, N=3)
+
+    parent_grid = Grid(
+        center_lon=-120, center_lat=30, nx=8, ny=13, size_x=3000, size_y=4000, rot=32
+    )
+    fname_restart = Path(download_test_data("eastpac25km_rst.19980106000000.nc"))
+
+    return InitialConditions(
+        grid=grid,
+        ini_time=datetime(1998, 1, 6),
+        source={"name": "ROMS", "path": fname_restart, "grid": parent_grid},  # type: ignore
+        bgc_source={"name": "ROMS", "path": fname_restart, "grid": parent_grid},  # type: ignore
+        use_dask=use_dask,
+    )
+
+
+@pytest.fixture(scope="session")
+def initial_conditions_from_roms_without_bgc(
+    use_dask: bool,
+) -> InitialConditions:
+    grid = Grid(nx=5, ny=5, center_lon=-120, center_lat=34, size_x=100, size_y=100, N=3)
+
+    parent_grid = Grid(
+        center_lon=-120, center_lat=30, nx=8, ny=13, size_x=3000, size_y=4000, rot=32
+    )
+    fname_restart = Path(download_test_data("eastpac25km_rst.19980106000000.nc"))
+
+    return InitialConditions(
+        grid=grid,
+        ini_time=datetime(1998, 1, 6),
+        source={"name": "ROMS", "path": fname_restart, "grid": parent_grid},  # type: ignore
+        use_dask=use_dask,
+    )
+
+
 @pytest.fixture(scope="session")
 def boundary_forcing(use_dask: bool, small_grid: Grid) -> BoundaryForcing:
     """Fixture for creating a BoundaryForcing object."""

{roms_tools-3.4.0 → roms_tools-3.5.0}/docs/end_to_end.ipynb

@@ -12339,7 +12339,15 @@
     "\n",
     "In the last section we have made all necessary input fields. We are now ready to run a ROMS-MARBL simulation!\n",
     "\n",
-    "Here we run a pre-compiled version of ROMS using a container. Containers can be used to run programs in portable, reproducible pre-configured environments."
+    "Here we run a pre-compiled version of ROMS using a container. Containers can be used to run programs in portable, reproducible pre-configured environments.\n",
+    "\n",
+    "<div class=\"alert alert-info\">\n",
+    "\n",
+    "Note\n",
+    "\n",
+    "This precompiled ROMS executable is built specifically for this example. As a result, compile-time options, such as the horizontal grid dimensions (`nx`, `ny`) used in this notebook, cannot be modified and still be expected to work with the precompiled ROMS executable in the container.\n",
+    "\n",
+    "</div>"
    ]
   },
   {
@@ -18840,7 +18848,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.7"
+   "version": "3.13.3"
   }
  },
  "nbformat": 4,

{roms_tools-3.4.0 → roms_tools-3.5.0}/docs/index.rst

@@ -27,7 +27,7 @@
 ROMS-Tools: Preparing and Analyzing ROMS Simulations
 =========================================================================
 
-**ROMS-Tools** is a Python package that automates the creation, management, and analysis of all input and output files needed for regional ocean simulations with `UCLA-ROMS <https://github.com/CESR-lab/ucla-roms>`_, with optional `MARBL biogeochemistry (BGC) <https://marbl-ecosys.github.io/versions/latest_release/index.html>`_.
+**ROMS-Tools** is a Python package that automates the creation, management, and analysis of all input and output files needed for regional ocean simulations with `UCLA-ROMS <https://github.com/CWorthy-ocean/ucla-roms>`_, with optional `MARBL biogeochemistry (BGC) <https://marbl-ecosys.github.io/versions/latest_release/index.html>`_.
 
 Built on ``xarray`` and optionally powered by ``dask``, ``ROMS-Tools`` automates the generation of all major ROMS–MARBL inputs, including: