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

roms_tools-0.20/.github/workflows/pre-commit.yaml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.1

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

@@ -0,0 +1,30 @@
+
+name: Build Documentation
+on:
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    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: 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.20/.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "mambaforge-22.9"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+conda:
+    environment: ci/environment.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

roms_tools-0.20/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.1
+Name: roms-tools
+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
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xarray>=2022.6.0
+Requires-Dist: numpy
+Requires-Dist: netcdf4
+Requires-Dist: pooch
+Requires-Dist: matplotlib
+Requires-Dist: cartopy
+Requires-Dist: packaging
+Requires-Dist: scipy
+Requires-Dist: gcm_filters
+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)
+
+## Overview
+
+A suite of python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
+
+## Installation instructions
+
+### Installation from pip
+
+```bash
+pip install roms-tools
+```
+
+### Installation from GitHub
+
+To obtain the latest development version, clone the source repository and install it:
+
+```bash
+git clone https://github.com/CWorthy-ocean/roms-tools.git
+cd roms-tools
+pip install -e .
+```
+
+
+### Run the tests
+
+Before running the tests, you can install and activate the following conda environment:
+
+```bash
+cd roms-tools
+conda env create -f ci/environment.yml
+conda activate romstools
+```
+
+Check the installation of `ROMS-Tools` has worked by running the test suite
+```bash
+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-0.20/README.md

@@ -0,0 +1,59 @@
+# 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)
+
+## Overview
+
+A suite of python tools for setting up a [ROMS](https://github.com/CESR-lab/ucla-roms) simulation.
+
+## Installation instructions
+
+### Installation from pip
+
+```bash
+pip install roms-tools
+```
+
+### Installation from GitHub
+
+To obtain the latest development version, clone the source repository and install it:
+
+```bash
+git clone https://github.com/CWorthy-ocean/roms-tools.git
+cd roms-tools
+pip install -e .
+```
+
+
+### Run the tests
+
+Before running the tests, you can install and activate the following conda environment:
+
+```bash
+cd roms-tools
+conda env create -f ci/environment.yml
+conda activate romstools
+```
+
+Check the installation of `ROMS-Tools` has worked by running the test suite
+```bash
+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-0.20/ci/environment.yml

@@ -0,0 +1,29 @@
+name: romstools
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - python>=3.9
+  - numpy
+  - scipy
+  - matplotlib
+  - cartopy
+  - xarray
+  - netcdf4
+  - pooch
+  - packaging
+  - numba
+  - gcm_filters
+  # testing
+  - pytest
+  - flake8
+  - black
+  - pre-commit
+  - coverage
+  # docs
+  - sphinx
+  - nbsphinx
+  - sphinx-book-theme
+  - sphinxcontrib-bibtex
+  # for running jupyter notebooks
+  - ipykernel

roms_tools-0.20/coverage.toml

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

roms_tools-0.20/docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+fresh: clean
+	rm -f generated/*.rst
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

roms_tools-0.20/docs/_templates/autosummary/class.rst

@@ -0,0 +1,31 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :special-members:
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: Methods
+   .. autosummary::
+      :toctree:
+   {% for item in all_methods %}
+      {%- if not item.startswith('_') or item in ['__call__',
+                                                  ] %}
+      {{ name }}.{{ item }}
+
+      {% endif %}
+   {% endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+   .. autosummary::
+   {% for item in attributes %}
+      {{ name }}.{{ item }}
+   {% endfor %}
+   {% endif %}
+   {% endblock %}

roms_tools-0.20/docs/api.rst

@@ -0,0 +1,54 @@
+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
+
+Atmospheric Forcing
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.AtmosphericForcing
+   roms_tools.SWRCorrection
+
+Initial Conditions
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.InitialConditions
+
+Boundary Forcing
+--------------------
+
+.. autosummary::
+   :toctree: generated/
+
+   roms_tools.BoundaryForcing
+
+=======