Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove code.json and disclaimer, update scripts #2240

Merged
merged 2 commits into from
Jun 20, 2024
Merged

chore: remove code.json and disclaimer, update scripts #2240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b307826
chore: remove code.json and disclaimer, update scripts
wpbonelli Jun 17, 2024
83d6544
fix update_version.py
wpbonelli Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions DISCLAIMER.md
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,17 +170,3 @@ MODFLOW Resources
+ [Online guide for MODFLOW-2000](https://water.usgs.gov/nrp/gwsoftware/modflow2000/Guide/)
+ [Online guide for MODFLOW-2005](https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/)
+ [Online guide for MODFLOW-NWT](https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/)


Disclaimer
----------

This software is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. This software is
provided "as is" and "as-available", and makes no representations or warranties
of any kind concerning the software, whether express, implied, statutory, or
other. This includes, without limitation, warranties of title,
merchantability, fitness for a particular purpose, non-infringement, absence
of latent or other defects, accuracy, or the presence or absence of errors,
whether or not known or discoverable.

49 changes: 0 additions & 49 deletions code.json
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions docs/PyPI_release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,3 @@ How to Cite
*Software/Code citation for FloPy:*

[Bakker, Mark, Post, Vincent, Hughes, J. D., Langevin, C. D., White, J. T., Leaf, A. T., Paulinski, S. R., Bellino, J. C., Morway, E. D., Toews, M. W., Larsen, J. D., Fienen, M. N., Starn, J. J., Brakenhoff, D. A., and Bonelli, W. P., 2024, FloPy v3.8.0.dev0 (preliminary): U.S. Geological Survey Software Release, 23 May 2024, https://doi.org/10.5066/F7BK19FH](https://doi.org/10.5066/F7BK19FH)


Disclaimer
----------

This software is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. This software is
provided "as is" and "as-available", and makes no representations or warranties
of any kind concerning the software, whether express, implied, statutory, or
other. This includes, without limitation, warranties of title,
merchantability, fitness for a particular purpose, non-infringement, absence
of latent or other defects, accuracy, or the presence or absence of errors,
whether or not known or discoverable.

11 changes: 0 additions & 11 deletions flopy/DISCLAIMER.md
View file
Open in desktop

This file was deleted.

7 changes: 2 additions & 5 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ For instance, `e689af57e7439b9005749d806248897ad550eab5_20150811_041632_uncommit
The `update_version.py` script can be used to update FloPy version numbers. Running the script first updates the version in `version.txt`, then propagates the change to various other places version strings or timestamps are embedded in the repository:

- `flopy/version.py`
- `flopy/DISCLAIMER.md`
- `CITATION.cff`
- `README.md`
- `docs/PyPI_release.md`
Expand All @@ -46,12 +45,10 @@ If the script is run with no arguments, the version number is not changed, but u
python scripts/update_version.py -v 3.3.6
```

To get the current version number, use the `--get` flag:
To get the current version number, use the `--get` flag (short `-g`):

```shell
python scripts/update_version.py
python scripts/update_version.py -g
```

This simply returns the contents of `version.txt` and does not write any changes to the repository's files.

By default, the script assumes a local development version of FloPy. The `--approve` flag should be used prior to releasing a new FloPy version. This will alter the `DISCLAIMER.md` file, substituting wording to indicate the version is no longer preliminary but approved for official release. See [the release docs](../docs/make_release.md) for more information.
Loading
Loading