release-v0.1.1

.github/workflows/test.yml

@@ -20,17 +20,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.9]
+        python-version: ["3.11"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: conda-incubator/setup-miniconda@v2
+      - uses: conda-incubator/setup-miniconda@v3
         with:
-          auto-update-conda: true
+          miniforge-version: latest
           python-version: ${{ matrix.python-version }}
-          channels: conda-forge
-          channel-priority: true
 
       - name: Show conda installation info
         run: |
@@ -39,17 +37,13 @@ jobs:
 
       - name: Install requirements
         run: |
-          conda install mamba
-          mamba install --file=requirements-build.txt --file=requirements-library.txt
-          mamba list
+          conda install --file=requirements-build.txt --file=requirements-library.txt --file=requirements-testing.txt
+          conda list
 
       - name: Build and install package
         run: |
           pip install -e .
 
-      - name: Install testing dependencies
-        run: mamba install --file=requirements-testing.txt
-
       - name: Test
         run: |
           python -c 'import pymt_roms'

CHANGES.rst

@@ -1,9 +1,9 @@
 Changelog for pymt_roms
 =======================
 
-0.2.0 (unreleased)
+0.1.1 (2024-10-31)
 -------------------
-
+- Update for pymt 1.3.2
 
 0.1.0 (2023-04-04)
 ------------------

README.rst

@@ -2,6 +2,8 @@
 pymt_roms
 =========
 
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15021596.svg
+        :target: https://doi.org/10.5281/zenodo.15021596
 
 .. image:: https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg
         :target: https://bmi.readthedocs.io/
@@ -61,27 +63,19 @@ into which to install it. This can be done with,
   conda create -n pymt python=3
   conda activate pymt
 
-.. Once the `conda-forge` channel has been enabled, `pymt` can be installed with:
-
-Once the environment is activated, `pymt` can be installed with the following command.
-**Please note that the `pymt_roms` requires the development version of `pymt` (e.g., v1.3.2dev0)**.
+Once the `conda-forge` channel has been enabled, `pymt` can be installed with:
 
 .. code::
 
-    # install pymt stable release and dependency packages
-    $ conda install pymt
-
-    # update to pymt dev version
-    $ pip install git+http://github.com/csdms/pymt
-
+   conda install pymt
 
-..  conda install pymt
+It is possible to list all of the versions of `pymt` available on your platform with:
 
-.. It is possible to list all of the versions of `pymt` available on your platform with:
+.. code::
 
-.. .. code::
+    conda search pymt --channel conda-forge
 
-..  conda search pymt --channel conda-forge
+**Please note that pymt_roms requires pymt version 1.3.2 or higher**
 
 --------------------
 Installing pymt_roms
@@ -99,9 +93,21 @@ or conda
 
   conda install -c conda-forge pymt_roms
 
+--------------------
+Citation
+--------------------
+Please include the following references when citing this software package:
+
+Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J.,
+Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024:
+CSDMS Data Components: data–model integration tools for Earth surface processes
+modeling. Geosci. Model Dev., 17, 2165–2185. https://doi.org/10.5194/gmd-17-2165-2024
+
+Gan, T. (2025). PyMT plugin for CSDMS ROMS Data Component. Zenodo. https://doi.org/10.5281/zenodo.15021596
+
 --------------------
 Coding Example
 --------------------
 
 You can learn more details about the coding example from the
-`tutorial notebook <https://github.com/gantian127/pymt_roms/blob/master/notebooks/pymt_roms.ipynb>`_.
+`tutorial notebook <https://github.com/gantian127/pymt_roms/blob/master/notebooks/pymt_roms.ipynb>`_.

docs/index.rst

@@ -35,26 +35,19 @@ into which to install it. This can be done with,
   conda create -n pymt python=3
   conda activate pymt
 
-.. Once the `conda-forge` channel has been enabled, `pymt` can be installed with:
-
-Once the environment is activated, `pymt` can be installed with the following command.
-**Please note that the `pymt_roms` requires the development version of `pymt` (e.g., v1.3.2dev0).**
+Once the `conda-forge` channel has been enabled, `pymt` can be installed with:
 
 .. code::
 
-    # install pymt stable release and dependency packages
-    $ conda install pymt
-
-    # update to pymt dev version
-    $ pip install git+http://github.com/csdms/pymt
+   conda install pymt
 
-..  conda install pymt
+It is possible to list all of the versions of `pymt` available on your platform with:
 
-.. It is possible to list all of the versions of `pymt` available on your platform with:
+.. code::
 
-.. .. code::
+    conda search pymt --channel conda-forge
 
-..  conda search pymt --channel conda-forge
+**Please note that pymt_roms requires pymt version 1.3.2 or higher**
 
 --------------------
 Installing pymt_roms
@@ -72,6 +65,18 @@ or conda
 
   conda install -c conda-forge pymt_roms
 
+--------------------
+Citation
+--------------------
+Please include the following references when citing this software package:
+
+Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J.,
+Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024:
+CSDMS Data Components: data–model integration tools for Earth surface processes
+modeling. Geosci. Model Dev., 17, 2165–2185. https://doi.org/10.5194/gmd-17-2165-2024
+
+Gan, T. (2025). PyMT plugin for CSDMS ROMS Data Component. Zenodo. https://doi.org/10.5281/zenodo.15021596
+
 --------------------
 Coding Example
 --------------------

meta/Roms/info.yaml

@@ -2,5 +2,5 @@ summary: This data component loads the ROMS model data from a local file or a UR
 url: https://github.com/gantian127/bmi_roms/
 author: Tian Gan
 email: [email protected]
-version: 0.1
+version: 0.1.1
 license: MIT

meta/Roms/parameters.yaml

@@ -4,12 +4,10 @@ filename:
   value:
     type: string
     default: 'https://tds.marine.rutgers.edu/thredds/dodsC/roms/doppio/2017_da/avg/runs/Averages_RUN_2023-03-31T00:00:00Z?s_rho[0:1:39],lon_rho[0:1:105][0:1:241],lat_rho[0:1:105][0:1:241],ocean_time[0:1:0],time[0:1:5],zeta[0:1:5][0:1:105][0:1:241],salt[0:1:5][0:1:39][0:1:105][0:1:241]'
-    units: 1
 
 download:
   name: Download data
   description: Indicate whether to download and save the data as a netCDF file with the provided URL
   value:
     type: bool
     default: False
-    units: 1

pymt_roms/bmi.py

@@ -1,7 +1,6 @@
 from __future__ import absolute_import
 
 import pkg_resources
-
 from bmi_roms import BmiRoms as Roms
 
 Roms.__name__ = "Roms"

readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

setup.py

@@ -27,7 +27,7 @@ def read(filename):
     author_email="[email protected]",
     description="PyMT plugin for pymt_roms",
     long_description=long_description,
-    version="0.1",
+    version="0.1.1",
     url="https://github.com/gantian127/pymt_roms",
     classifiers=[
         "Development Status :: 4 - Beta",
@@ -36,7 +36,10 @@ def read(filename):
         "Operating System :: MacOS :: MacOS X",
         "Operating System :: POSIX :: Linux",
         "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
     ],
     keywords=["bmi", "pymt"],
     install_requires=open("requirements.txt", "r").read().splitlines(),