From 65e54e86cbc4b33b3779d13c90df513cd3825f10 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Dec 2024 23:49:05 +0000 Subject: [PATCH 1/6] ci(release): set version to 2.0.0 --- pywatershed/version.py | 5 +++-- version.txt | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/pywatershed/version.py b/pywatershed/version.py index 3f5a1892..24fc914b 100644 --- a/pywatershed/version.py +++ b/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 23:49:01 #noqa: E501 -__version__ = "1.2.0.dev0" +__version__ = "2.0.0" __pakname__ = "pywatershed" author_dict = { "James McCreight": "jmccreight@usgs.gov", "Christian D. Langevin": "langevin@usgs.gov", "Joseph D. Hughes": "jdhughes@usgs.gov", + "Wesley P. Bonelli": "wbonelli@contractor.usgs.gov", } __author__ = ", ".join(author_dict.keys()) __author_email__ = ", ".join(s for _, s in author_dict.items()) diff --git a/version.txt b/version.txt index 0148841b..359a5b95 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.2.0.dev0 +2.0.0 \ No newline at end of file From a03449ff19103f40ce74f568349a6709d4619cb5 Mon Sep 17 00:00:00 2001 From: James McCreight Date: Mon, 16 Dec 2024 18:07:11 -0700 Subject: [PATCH 2/6] advance development version to 2.1.0.dev0 --- doc/whats-new.rst | 18 ++++++++++++++++++ pywatershed/version.py | 4 ++-- version.txt | 2 +- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 8acd98d9..2a86978c 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -12,6 +12,24 @@ 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.0: v2.0.0 (16 December 2024) diff --git a/pywatershed/version.py b/pywatershed/version.py index 24fc914b..b376a34b 100644 --- a/pywatershed/version.py +++ b/pywatershed/version.py @@ -1,6 +1,6 @@ -# pywatershed version file automatically created using update_version.py on December 16, 2024 23:49:01 #noqa: E501 +# pywatershed version file automatically created using update_version.py on December 16, 2024 18:04:16 #noqa: E501 -__version__ = "2.0.0" +__version__ = "2.1.0.dev0" __pakname__ = "pywatershed" author_dict = { diff --git a/version.txt b/version.txt index 359a5b95..0ae98a3f 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -2.0.0 \ No newline at end of file +2.1.0.dev0 \ No newline at end of file From 43777900f600dd85f738b789b0dab3486a1ad48d Mon Sep 17 00:00:00 2001 From: James McCreight Date: Wed, 18 Dec 2024 17:42:20 -0700 Subject: [PATCH 3/6] patch v2.0.1 --- .github/RELEASE.md | 10 +++++++--- .github/workflows/release.yaml | 2 +- README.md | 30 +++++++++--------------------- 3 files changed, 17 insertions(+), 25 deletions(-) diff --git a/.github/RELEASE.md b/.github/RELEASE.md index 27c39684..2be1c58e 100644 --- a/.github/RELEASE.md +++ b/.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`. diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index ceb5bdaf..a50098b1 100644 --- a/.github/workflows/release.yaml +++ b/.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 diff --git a/README.md b/README.md index 506b7c18..8c315a7c 100644 --- a/README.md +++ b/README.md @@ -153,27 +153,15 @@ 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 has been approved for release by the U.S. Geological Survey (USGS). Although the +software has been subjected to rigorous review, the USGS reserves the right to update the +software as needed pursuant to further analysis and review. 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. Furthermore, the software +is released on condition that neither the USGS nor the U.S. Government shall be held liable +for any damages resulting from its authorized or unauthorized use. \ No newline at end of file From e373b848b9acb4a62e2bc6749de61b26678f3503 Mon Sep 17 00:00:00 2001 From: James McCreight Date: Thu, 19 Dec 2024 13:42:14 -0700 Subject: [PATCH 4/6] patch: update env files and the whats new --- doc/whats-new.rst | 10 ++++++++++ environment.yml | 18 ++++++++---------- environment_w_jupyter.yml | 18 ++++++++---------- 3 files changed, 26 insertions(+), 20 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 8acd98d9..0a87b2ec 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -12,6 +12,16 @@ What's New np.random.seed(123456) +.. _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) diff --git a/environment.yml b/environment.yml index a12c058e..504f798a 100644 --- a/environment.yml +++ b/environment.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 @@ -17,6 +18,7 @@ dependencies: - 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 diff --git a/environment_w_jupyter.yml b/environment_w_jupyter.yml index f27880f7..b3f4dd21 100644 --- a/environment_w_jupyter.yml +++ b/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 From 470ee0c774e18159d9461e1b72994184c2a2c477 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Dec 2024 21:53:38 +0000 Subject: [PATCH 5/6] ci(release): set version to 2.0.1 --- pywatershed/version.py | 4 ++-- version.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pywatershed/version.py b/pywatershed/version.py index 24fc914b..fee074b5 100644 --- a/pywatershed/version.py +++ b/pywatershed/version.py @@ -1,6 +1,6 @@ -# pywatershed version file automatically created using update_version.py on December 16, 2024 23:49:01 #noqa: E501 +# pywatershed version file automatically created using update_version.py on December 19, 2024 21:53:33 #noqa: E501 -__version__ = "2.0.0" +__version__ = "2.0.1" __pakname__ = "pywatershed" author_dict = { diff --git a/version.txt b/version.txt index 359a5b95..10bf840e 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -2.0.0 \ No newline at end of file +2.0.1 \ No newline at end of file From c1316ff003ed99c3db2ea0857a18786dd58ac650 Mon Sep 17 00:00:00 2001 From: James McCreight Date: Thu, 19 Dec 2024 15:45:10 -0700 Subject: [PATCH 6/6] revert disclaimer to develop/unapproved --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8c315a7c..dbaa9b37 100644 --- a/README.md +++ b/README.md @@ -158,10 +158,11 @@ McCreight, J. L., Langevin, C. D., Hughes, J. D., & Bonelli, W. P. (2024). pywat ## Disclaimer -This software has been approved for release by the U.S. Geological Survey (USGS). Although the -software has been subjected to rigorous review, the USGS reserves the right to update the -software as needed pursuant to further analysis and review. 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. Furthermore, the software -is released on condition that neither the USGS nor the U.S. Government shall be held liable -for any damages resulting from its authorized or unauthorized use. \ No newline at end of file +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. \ No newline at end of file