Merge pull request #323 from jmccreight/main_to_dev_2.0.1

Main to dev 2.0.1

.github/RELEASE.md

@@ -44,14 +44,16 @@ To release a new version:
    `v{major}.{minor}.{patch}` ([semantic version](https://semver.org/) number
    with a leading 'v'). For instance, for a minor release, if this repo is an
    `upstream` remote and one's local `develop` is up to date with upstream
-   `develop`, then from `develop` run `git switch -c vx.y.z`. 
+   `develop`, then from `develop` run `git switch -c vx.y.z`.
 
 1. If this is a patch release, make changes/fixes locally. If this is a major or
    minor release, no changes may be needed. In either case, add the release version
    and date to the top of `doc/whats-new.rst`. If a patch, put it below the
    pending minor release. Also update the version in `doc/index.rst`. Update the
    CITATION.cff file. If a major release, get the provisional new DOI from USGS
-   and add it to CITATION.cff and the main README.md.
+   and add it to CITATION.cff and the top-level README.md. If the release is
+   approved, put the disclaimer for approved releases onthe top-level README.md.
+   Otherwise keep the provisional disclaimer.
 
 1. Push the branch to this repo. For instance, if this repo is an `upstream`
    remote: `git push -u upstream vx.y.z`. This starts a job to:
@@ -103,13 +105,15 @@ To release a new version:
 
 1. In the case of a minor or major release,  (a patch would be applied to both
    main and develop?) a couple of manual steps:
-   - Check out `main` as a new branch to get it back into develop,
+   - Check out `main` as a new branch in order to get it back into develop,
      eg feat_main_to_dev.
    - Run `.github/scripts/update_version.py -v x.y+1.0.dev0` to update
      `version.txt` and `pywatershed/version.py` with the minor version number
      incremented. The `.dev0` suffix indicates preliminary development status.
    - Add a new minor release to the top of `doc/whats-new.rst`
    - Incorporate the ASV details from the previous section above.
+   - If main was an approved release, revert the disclaimer on the top-level
+     README.md to the provisional disclaimer.
    - Open a PR against `develop` with the updated version files and the
      updates previously merged to `main`.
 

.github/workflows/release.yaml

@@ -331,7 +331,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.10
+          python-version: "3.10"
           cache: 'pip'
           cache-dependency-path: pyproject.toml
 

README.md

@@ -153,27 +153,16 @@ guidelines.
 Thank you for your interest.
 
 ## How to Cite
-McCreight, J., Langevin, C. D., Hughes, J. D., & Bonelli, W. P. (2024). pywatershed (Version 2.0.0) [Computer software]. [https://doi.org/10.5066/P13EWPEV](https://doi.org/10.5066/P13EWPEV)
+
+McCreight, J. L., Langevin, C. D., Hughes, J. D., & Bonelli, W. P. (2024). pywatershed (Version 2.0.0) [Computer software]. [https://doi.org/10.5066/P13EWPEV](https://doi.org/10.5066/P13EWPEV)
 
 ## Disclaimer
 
-This information is preliminary or provisional and is subject to revision. It is
-being provided to meet the need for timely best science. The information has not
-received final approval by the U.S. Geological Survey (USGS) and is provided on
-the condition that neither the USGS nor the U.S. Government shall be held liable
-for any damages resulting from the authorized or unauthorized use of the
-information.
-
-From: https://www2.usgs.gov/fsp/fsp_disclaimers.asp#5
-
-This software is in the public domain because it contains materials that
-originally came from the U.S. Geological Survey, an agency of the United States
-Department of Interior. For more information, see the [official USGS copyright
-policy](https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits
-"official USGS copyright policy")
-
-Although this software program has been used by the USGS, no warranty, expressed
-or implied, is made by the USGS or the U.S. Government as to the accuracy and
-functioning of the program and related program material nor shall the fact of
-distribution constitute any such warranty, and no responsibility is assumed by
-the USGS in connection therewith.  This software is provided "AS IS."
+This software is preliminary or provisional and is subject to revision. It is
+being provided to meet the need for timely best science. The software has not
+received final approval by the U.S. Geological Survey (USGS). No warranty,
+expressed or implied, is made by the USGS or the U.S. Government as to the
+functionality of the software and related material nor shall the fact of
+release constitute any such warranty. The software is provided on the condition
+that neither the USGS nor the U.S. Government shall be held liable for any
+damages resulting from the authorized or unauthorized use of the software.

doc/whats-new.rst

@@ -12,6 +12,34 @@ What's New
     np.random.seed(123456)
 
 
+.. _whats-new.2.1.0:
+
+v2.1.0 (Unreleased)
+---------------------
+
+New Features
+~~~~~~~~~~~~~~~~
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+
+Bug fixes
+~~~~~~~~~
+
+Internal changes
+~~~~~~~~~~~~~~~~
+
+
+.. _whats-new.2.0.1:
+
+v2.0.1 (19 December 2024)
+---------------------
+
+New Features
+~~~~~~~~~~~~~~~~
+Corrected disclaimer on top-level README.md. Other minor fixes not to code base (CI, envs, etc).
+
+
 .. _whats-new.2.0.0:
 
 v2.0.0 (16 December 2024)

environment.yml

@@ -2,21 +2,23 @@ name: pws
 channels:
   - conda-forge
   - nodefaults
-  - pyviz
-  - bioconda
 dependencies:
+  - asv
   - cartopy
+  - click != 8.1.0
   - dataretrieval
   - contextily
-  - epiweeks
+  - epiweeks4cf
   - filelock
+  - flopy
   - folium
   - geopandas
   - geoviews
   - git
   - holoviews
   - hvplot
   - ipython
+  - modflow-devtools
   - netCDF4
   - networkx
   - numpy>=2.0.0
@@ -33,20 +35,16 @@ dependencies:
   - pytest-xdist
   - python<3.12,>=3.10
   - pyyaml
+  - ruff
   - shapely
   - sphinx
   - sphinx-book-theme>=0.3.3
+  - sphinx-autodoc-typehints>=2.2.1
   - sphinx-autosummary-accessors
   - sphinx-copybutton
   - tqdm
   - xarray>=2024.06.0
+  - xmltodict
   - pip:
-      - asv
-      - click != 8.1.0
-      - filelock
-      - git+https://github.com/modflowpy/flopy.git
-      - modflow-devtools
       - git+https://github.com/jararias/mpsplines.git
       - git+https://github.com/paknorton/pyPRMS.git@development
-      - sphinx-autodoc-typehints>=2.2.1
-      - ruff

environment_w_jupyter.yml

@@ -2,14 +2,15 @@ name: pws
 channels:
   - conda-forge
   - nodefaults
-  - pyviz
-  - bioconda
 dependencies:
+  - asv
   - cartopy
+  - click != 8.1.0
   - dataretrieval
   - contextily
-  - epiweeks
+  - epiweeks4cf
   - filelock
+  - flopy
   - folium
   - geopandas
   - geoviews
@@ -25,6 +26,7 @@ dependencies:
   - networkx
   - numpy>=2.0.0
   - numba
+  - modflow-devtools
   - pandas>=1.4.0
   - pint
   - pip
@@ -37,21 +39,17 @@ dependencies:
   - pytest-xdist
   - python<3.12,>=3.10
   - pyyaml
+  - ruff
   - shapely
   - sphinx
   - sphinx-book-theme>=0.3.3
+  - sphinx-autodoc-typehints>=2.2.1
   - sphinx-autosummary-accessors
   - sphinx-copybutton
   - tqdm
   - xarray>=2024.06.0
+  - xmltodict
   - pip:
-      - asv
-      - click != 8.1.0
-      - filelock
-      - git+https://github.com/modflowpy/flopy.git
       - jupyter_black
-      - modflow-devtools
       - git+https://github.com/jararias/mpsplines.git
       - git+https://github.com/paknorton/pyPRMS.git@development
-      - sphinx-autodoc-typehints>=2.2.1
-      - ruff

pywatershed/version.py

@@ -1,12 +1,13 @@
-# pywatershed version file automatically created using update_version.py on June 27, 2024 11:59:27  # noqa: E501
+# pywatershed version file automatically created using update_version.py on December 16, 2024 18:04:16  #noqa: E501
 
-__version__ = "1.2.0.dev0"
+__version__ = "2.1.0.dev0"
 __pakname__ = "pywatershed"
 
 author_dict = {
     "James McCreight": "[email protected]",
     "Christian D. Langevin": "[email protected]",
     "Joseph D. Hughes": "[email protected]",
+    "Wesley P. Bonelli": "[email protected]",
 }
 __author__ = ", ".join(author_dict.keys())
 __author_email__ = ", ".join(s for _, s in author_dict.items())

version.txt

@@ -1 +1 @@
-1.2.0.dev0
+2.1.0.dev0