PyPI - roms-tools - Versions diffs - 0.1.0__tar.gz → 1.0.0__tar.gz - Mend

roms-tools 0.1.0tar.gz → 1.0.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

{roms_tools-0.1.0 → roms_tools-1.0.0}/.github/workflows/sphinx.yaml RENAMED Viewed

@@ -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-1.0.0/.github/workflows/tests.yaml ADDED Viewed

@@ -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_surface_forcing.py roms_tools/tests/test_initial_conditions.py roms_tools/tests/test_vertical_coordinate.py roms_tools/tests/test_boundary_forcing.py roms_tools/tests/test_utils.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-1.0.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: roms-tools
-Version: 0.1.0
+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
@@ -19,6 +19,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: xarray>=2022.6.0
+Requires-Dist: xarray-datatree
 Requires-Dist: numpy
 Requires-Dist: netcdf4
 Requires-Dist: pooch
@@ -31,8 +32,12 @@ Requires-Dist: numba
 # 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)
+[![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)
+![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
@@ -59,7 +64,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-1.0.0}/README.md RENAMED Viewed

@@ -1,7 +1,11 @@
 # 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)
+[![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)
+![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
@@ -28,7 +32,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-1.0.0}/ci/environment.yml RENAMED Viewed

@@ -9,6 +9,7 @@ dependencies:
   - matplotlib
   - cartopy
   - xarray
+  - xarray-datatree
   - netcdf4
   - pooch
   - packaging
@@ -19,6 +20,7 @@ dependencies:
   - flake8
   - black
   - pre-commit
+  - coverage
   # docs
   - sphinx
   - nbsphinx

roms_tools-1.0.0/coverage.toml ADDED Viewed

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

roms_tools-1.0.0/docs/api.rst ADDED Viewed

@@ -0,0 +1,53 @@
+API Reference
+#############
+Grid
+------------------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.Grid
+Vertical Coordinate
+------------------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.VerticalCoordinate
+Tidal Forcing
+------------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.TidalForcing
+Surface Forcing
+----------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.SurfaceForcing
+Initial Conditions
+--------------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.InitialConditions
+Boundary Forcing
+--------------------
+.. autosummary::
+   :toctree: generated/
+   roms_tools.BoundaryForcing
+=======

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

roms-tools 0.1.0tar.gz → 1.0.0tar.gz