roms-tools 0.1.0__tar.gz → 0.20__tar.gz

{roms_tools-0.1.0 → roms_tools-0.20}/.github/workflows/sphinx.yaml

@@ -8,22 +8,23 @@ on:
 jobs:
   docs:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash -l {0}
     steps:
       - uses: actions/checkout@v4
       - name: Create conda environment
-        uses: mamba-org/provision-with-micromamba@main
+        uses: mamba-org/setup-micromamba@v1
         with:
           cache-downloads: true
+          cache-environment: true
           micromamba-version: 'latest'
           environment-file: ci/environment.yml
-          extra-specs: |
+          create-args: |
             python=${{ matrix.python-version }}
       - name: Install roms-tools
+        shell: micromamba-shell {0}
         run: |
+           python - V
            python -m pip install -e . --no-deps --force-reinstall
       - name: Build Docs
+        shell: bash -l {0}
         run: |
           cd docs ; make fresh; make html

roms_tools-0.20/.github/workflows/tests.yaml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+
+  test:
+    name: ${{ matrix.python-version }}-build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create conda environment
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          cache-downloads: true
+          cache-environment: true
+          micromamba-version: 'latest'
+          environment-file: ci/environment.yml
+          create-args: |
+            python=${{ matrix.python-version }}
+
+      - name: Conda info
+        run: conda info
+
+      - name: Install roms-tools
+        shell: micromamba-shell {0}
+        run: |
+           python - V
+           python -m pip install -e . --no-deps --force-reinstall
+
+      - name: Running Tests
+        shell: bash -l {0}
+        run: |
+           python -V
+           coverage run --rcfile=coverage.toml -m pytest --verbose roms_tools/tests/test_datasets.py roms_tools/tests/test_grid.py roms_tools/tests/test_topography.py roms_tools/tests/test_tides.py roms_tools/tests/test_atmospheric_forcing.py roms_tools/tests/test_initial_conditions.py roms_tools/tests/test_vertical_coordinate.py roms_tools/tests/test_boundary_forcing.py
+
+      - name: Get coverage report
+        shell: bash -l {0}
+        run: |
+          coverage report -m ; coverage xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests # optional

{roms_tools-0.1.0/roms_tools.egg-info → roms_tools-0.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 0.1.0
+Version: 0.20
 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
@@ -31,6 +31,7 @@ Requires-Dist: numba
 
 # 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)
 
@@ -59,7 +60,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-0.1.0 → roms_tools-0.20}/README.md

@@ -1,5 +1,6 @@
 # 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)
 
@@ -28,7 +29,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-0.1.0 → roms_tools-0.20}/ci/environment.yml

@@ -19,6 +19,7 @@ dependencies:
   - flake8
   - black
   - pre-commit
+  - coverage
   # docs
   - sphinx
   - nbsphinx

roms_tools-0.20/coverage.toml

@@ -0,0 +1,5 @@
+[tool.coverage.run]
+omit = [
+    "roms_tools/tests/*",
+    "**/__init__.py",
+]

{roms_tools-0.1.0 → roms_tools-0.20}/docs/api.rst

@@ -10,6 +10,14 @@ Grid
 
    roms_tools.Grid
 
+Vertical Coordinate
+------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.VerticalCoordinate
+
 Tidal Forcing
 ------------------
 
@@ -27,4 +35,20 @@ Atmospheric Forcing
    roms_tools.AtmosphericForcing
    roms_tools.SWRCorrection
 
+Initial Conditions
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.InitialConditions
+
+Boundary Forcing
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.BoundaryForcing
+
 =======