roms-tools 1.6.1__tar.gz → 1.7.0__tar.gz

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

@@ -0,0 +1,106 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-without-dask:
+    name: ${{ matrix.python-version }}-build-without-dask
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    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 }}
+          cache-key: micromamba-${{ matrix.python-version }}-${{ runner.os }}
+
+      - name: Conda info
+        run: conda info
+
+      - name: Install roms-tools
+        shell: micromamba-shell {0}
+        run: |
+           python -V
+           python -m pip install -e . --force-reinstall
+
+      - name: Running Tests without Dask
+        shell: bash -l {0}
+        run: |
+           python -V
+           coverage run --rcfile=coverage.toml -m pytest --verbose roms_tools/tests/*
+
+      - 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
+
+  test-with-dask:
+    name: 3.13-build-with-dask
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+    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 }}
+          cache-key: micromamba-${{ matrix.python-version }}-${{ runner.os }}
+
+      - name: Conda info
+        run: conda info
+
+      - name: Install roms-tools
+        shell: micromamba-shell {0}
+        run: |
+           python -V
+           python -m pip install -e .[dask]  --force-reinstall
+
+      - name: Running Tests with Dask
+        shell: bash -l {0}
+        run: |
+           python -V
+           coverage run --rcfile=coverage.toml -m pytest --use_dask --verbose roms_tools/tests/*
+
+      - 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-1.7.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.1
+Name: roms-tools
+Version: 1.7.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
+Project-URL: Home, https://github.com/CWorthy-ocean/roms-tools
+Project-URL: Documentation, https://roms-tools.readthedocs.io/en/latest/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xarray>=2022.6.0
+Requires-Dist: numpy
+Requires-Dist: pooch
+Requires-Dist: matplotlib
+Requires-Dist: cartopy
+Requires-Dist: packaging
+Requires-Dist: scipy
+Requires-Dist: gcm_filters
+Requires-Dist: netcdf4
+Requires-Dist: PyYAML
+Requires-Dist: pyamg
+Requires-Dist: bottleneck
+Provides-Extra: dask
+Requires-Dist: dask[diagnostics]; extra == "dask"
+
+# ROMS-Tools
+[![Conda version](https://img.shields.io/conda/vn/conda-forge/roms-tools.svg)](https://anaconda.org/conda-forge/roms-tools)
+[![PyPI version](https://img.shields.io/pypi/v/roms-tools.svg)](https://pypi.org/project/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
+
+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>
+
+## Installation
+
+### Installation from conda forge
+
+```bash
+conda install -c conda-forge roms-tools
+```
+
+This command installs `ROMS-Tools` along with its `dask` dependency.
+
+### Installation from pip
+
+```bash
+pip install roms-tools
+```
+
+If you want to use `ROMS-Tools` together with dask (which we recommend), you can
+install `ROMS-Tools` along with the additional dependency via:
+
+```bash
+pip install roms-tools[dask]
+```
+
+### Installation from GitHub
+
+To obtain the latest development version, first clone the source repository:
+
+```bash
+git clone https://github.com/CWorthy-ocean/roms-tools.git
+cd roms-tools
+```
+
+Next, install and activate the following conda environment:
+
+```bash
+conda env create -f ci/environment.yml
+conda activate romstools-test
+```
+
+Finally, install `ROMS-Tools` in the same environment:
+
+```bash
+pip install -e .
+```
+
+If you want to use `ROMS-Tools` together with dask (which we recommend), you can
+install `ROMS-Tools` along with the additional dependency via:
+
+```bash
+pip install -e ".[dask]"
+```
+
+
+### Run the tests
+
+Before running the tests, you can activate the conda environment created in the previous section:
+
+```bash
+conda activate romstools-test
+```
+
+Check the installation of `ROMS-Tools` has worked by running the test suite
+```bash
+cd roms-tools
+pytest
+```
+
+## Getting Started
+
+To learn how to use `ROMS-Tools`, check out the [documentation](https://roms-tools.readthedocs.io/en/latest/).
+
+## Feedback and contributions
+
+**If you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.**
+
+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-1.7.0/README.md

@@ -0,0 +1,97 @@
+# ROMS-Tools
+[![Conda version](https://img.shields.io/conda/vn/conda-forge/roms-tools.svg)](https://anaconda.org/conda-forge/roms-tools)
+[![PyPI version](https://img.shields.io/pypi/v/roms-tools.svg)](https://pypi.org/project/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
+
+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>
+
+## Installation
+
+### Installation from conda forge
+
+```bash
+conda install -c conda-forge roms-tools
+```
+
+This command installs `ROMS-Tools` along with its `dask` dependency.
+
+### Installation from pip
+
+```bash
+pip install roms-tools
+```
+
+If you want to use `ROMS-Tools` together with dask (which we recommend), you can
+install `ROMS-Tools` along with the additional dependency via:
+
+```bash
+pip install roms-tools[dask]
+```
+
+### Installation from GitHub
+
+To obtain the latest development version, first clone the source repository:
+
+```bash
+git clone https://github.com/CWorthy-ocean/roms-tools.git
+cd roms-tools
+```
+
+Next, install and activate the following conda environment:
+
+```bash
+conda env create -f ci/environment.yml
+conda activate romstools-test
+```
+
+Finally, install `ROMS-Tools` in the same environment:
+
+```bash
+pip install -e .
+```
+
+If you want to use `ROMS-Tools` together with dask (which we recommend), you can
+install `ROMS-Tools` along with the additional dependency via:
+
+```bash
+pip install -e ".[dask]"
+```
+
+
+### Run the tests
+
+Before running the tests, you can activate the conda environment created in the previous section:
+
+```bash
+conda activate romstools-test
+```
+
+Check the installation of `ROMS-Tools` has worked by running the test suite
+```bash
+cd roms-tools
+pytest
+```
+
+## Getting Started
+
+To learn how to use `ROMS-Tools`, check out the [documentation](https://roms-tools.readthedocs.io/en/latest/).
+
+## Feedback and contributions
+
+**If you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.**
+
+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-1.7.0/ci/environment.yml

@@ -0,0 +1,14 @@
+name: romstools-test
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - python>=3.10
+  # testing
+  - zarr
+  - pytest
+  - pytest-xdist
+  - flake8
+  - black
+  - pre-commit==3.8.0
+  - coverage