Merge pull request #605 from nci/develop

Release 1.0.0

Author: tennlee

.binder/requirements.txt

@@ -381,7 +381,7 @@ xarray==2024.3.0
     # via
     #   rioxarray
     #   scores (pyproject.toml)
-zipp==3.18.1
+zipp==3.19.1
     # via
     #   importlib-metadata
     #   importlib-resources

CITATION.cff

@@ -1,73 +1,82 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
+cff-version: "1.2.0"
 authors:
-- given-names: Tennessee 
-  family-names: Leeuwenburg
+- family-names: Leeuwenburg
+  given-names: Tennessee
   orcid: "https://orcid.org/0009-0008-2024-1967"
-- given-names: Nicholas 
-  family-names: Loveday
+- family-names: Loveday
+  given-names: Nicholas
   orcid: "https://orcid.org/0009-0000-5796-7069"
-- given-names: Elizabeth E. 
-  family-names: Ebert
-- given-names: Harrison 
-  family-names: Cook
+- family-names: Ebert
+  given-names: Elizabeth E.
+- family-names: Cook
+  given-names: Harrison
   orcid: "https://orcid.org/0009-0009-3207-4876"
-- given-names: Mohammadreza 
-  family-names: Khanarmuei
+- family-names: Khanarmuei
+  given-names: Mohammadreza
   orcid: "https://orcid.org/0000-0002-5017-9622"
-- given-names: Robert J. 
-  family-names: Taggart
+- family-names: Taggart
+  given-names: Robert J.
   orcid: "https://orcid.org/0000-0002-0067-5687"
-- given-names: Nikeeth 
-  family-names: Ramanathan
+- family-names: Ramanathan
+  given-names: Nikeeth
   orcid: "https://orcid.org/0009-0002-7406-7438"
-- given-names: Maree 
-  family-names: Carroll
+- family-names: Carroll
+  given-names: Maree
   orcid: "https://orcid.org/0009-0008-6830-8251"
-- given-names: Stephanie 
-  family-names: Chong
+- family-names: Chong
+  given-names: Stephanie
   orcid: "https://orcid.org/0009-0007-0796-4127"
-- given-names: Aidan 
-  family-names: Griffiths
-- given-names: John 
-  family-names: Sharples  
-
-title: "scores: A Python package for verifying and evaluating models and predictions with xarray"  
-
+- family-names: Griffiths
+  given-names: Aidan
+- family-names: Sharples
+  given-names: John
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+title: "scores: A Python package for verifying and evaluating models and
+  predictions with xarray"  
 preferred-citation:
-  type: article
-  doi: "10.48550/arXiv.2406.07817"
-  journal: "arXiv"
-  title: "scores: A Python package for verifying and evaluating models and predictions with xarray"
   authors:
-  - given-names: Tennessee 
-    family-names: Leeuwenburg
+  - family-names: Leeuwenburg
+    given-names: Tennessee
     orcid: "https://orcid.org/0009-0008-2024-1967"
-  - given-names: Nicholas 
-    family-names: Loveday
+  - family-names: Loveday
+    given-names: Nicholas
     orcid: "https://orcid.org/0009-0000-5796-7069"
-  - given-names: Elizabeth E. 
-    family-names: Ebert
-  - given-names: Harrison 
-    family-names: Cook
+  - family-names: Ebert
+    given-names: Elizabeth E.
+  - family-names: Cook
+    given-names: Harrison
     orcid: "https://orcid.org/0009-0009-3207-4876"
-  - given-names: Mohammadreza 
-    family-names: Khanarmuei
+  - family-names: Khanarmuei
+    given-names: Mohammadreza
     orcid: "https://orcid.org/0000-0002-5017-9622"
-  - given-names: Robert J. 
-    family-names: Taggart
+  - family-names: Taggart
+    given-names: Robert J.
     orcid: "https://orcid.org/0000-0002-0067-5687"
-  - given-names: Nikeeth 
-    family-names: Ramanathan
+  - family-names: Ramanathan
+    given-names: Nikeeth
     orcid: "https://orcid.org/0009-0002-7406-7438"
-  - given-names: Maree 
-    family-names: Carroll
+  - family-names: Carroll
+    given-names: Maree
     orcid: "https://orcid.org/0009-0008-6830-8251"
-  - given-names: Stephanie 
-    family-names: Chong
+  - family-names: Chong
+    given-names: Stephanie
     orcid: "https://orcid.org/0009-0007-0796-4127"
-  - given-names: Aidan 
-    family-names: Griffiths
-  - given-names: John 
-    family-names: Sharples  
-  year: 2024
+  - family-names: Griffiths
+    given-names: Aidan
+  - family-names: Sharples
+    given-names: John
+  date-published: 2024-07-09
+  doi: 10.21105/joss.06889
+  issn: 2475-9066
+  issue: 99
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 6889
+  title: "scores: A Python package for verifying and evaluating models
+    and predictions with xarray"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.06889"
+  volume: 9
+

README.md

@@ -1,6 +1,6 @@
 # scores: Verification and Evaluation for Forecasts and Models
 
-[![CodeQL](https://github.com/nci/scores/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/nci/scores/actions/workflows/github-code-scanning/codeql) [![Coverage Status](https://coveralls.io/repos/github/nci/scores/badge.svg)](https://coveralls.io/github/nci/scores) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nci/scores/main?labpath=tutorials%2FTutorial_Gallery.ipynb)
+[![CodeQL](https://github.com/nci/scores/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/nci/scores/actions/workflows/github-code-scanning/codeql) [![Coverage Status](https://coveralls.io/repos/github/nci/scores/badge.svg)](https://coveralls.io/github/nci/scores) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nci/scores/main?labpath=tutorials%2FTutorial_Gallery.ipynb) [![DOI](https://joss.theoj.org/papers/10.21105/joss.06889/status.svg)](https://doi.org/10.21105/joss.06889)
 
 > 
 > **A list of over 50 metrics, statistical techniques and data processing tools contained in `scores` is [available here](https://scores.readthedocs.io/en/stable/included.html).**
@@ -71,9 +71,22 @@ All metrics, statistical techniques and data processing tools in `scores` work w
 
 ## Acknowledging This Work
 
-If you use `scores` for a published work, we would appreciate you citing our arXiv preprint:
+If you use `scores` for a published work, we would appreciate you citing our [paper](https://doi.org/10.21105/joss.06889):
 
-Leeuwenburg, T., Loveday, N., Ebert, E. E., Cook, H., Khanarmuei, M., Taggart, R. J., Ramanathan, N., 
-Carroll, M., Chong, S., Griffiths, A., & Sharples, J. (2024). *scores: A Python package for verifying and 
-evaluating models and predictions with xarray*. arXiv. [https://doi.org/10.48550/arXiv.2406.07817](https://doi.org/10.48550/arXiv.2406.07817)
+Leeuwenburg, T., Loveday, N., Ebert, E. E., Cook, H., Khanarmuei, M., Taggart, R. J., Ramanathan, N., Carroll, M., Chong, S., Griffiths, A., & Sharples, J. (2024). scores: A Python package for verifying and evaluating models and predictions with xarray. *Journal of Open Source Software, 9*(99), 6889. [https://doi.org/10.21105/joss.06889](https://doi.org/10.21105/joss.06889)
 
+BibTeX:
+```
+@article{Leeuwenburg_scores_A_Python_2024,
+author = {Leeuwenburg, Tennessee and Loveday, Nicholas and Ebert, Elizabeth E. and Cook, Harrison and Khanarmuei, Mohammadreza and Taggart, Robert J. and Ramanathan, Nikeeth and Carroll, Maree and Chong, Stephanie and Griffiths, Aidan and Sharples, John},
+doi = {10.21105/joss.06889},
+journal = {Journal of Open Source Software},
+month = jul,
+number = {99},
+pages = {6889},
+title = {{scores: A Python package for verifying and evaluating models and predictions with xarray}},
+url = {https://joss.theoj.org/papers/10.21105/joss.06889},
+volume = {9},
+year = {2024}
+}
+```

docs/conf.py

@@ -9,7 +9,7 @@
 
 project = "scores"
 copyright = "Licensed under Apache 2.0 - https://www.apache.org/licenses/LICENSE-2.0"
-release = "0.9.3"
+release = "1.0.0"
 
 version = __version__
 

docs/release_notes.md

@@ -1,5 +1,35 @@
 # Release Notes (What's New)
 
+## Version 1.0.0 (July 10, 2024)
+
+We are happy to have reached the point of releasing “Version 1.0.0” of `scores`. While we look forward to many version increments to come, version 1.0.0 represents a milestone. It signifies a stabilisation of the API, and marks a turning point from the initial construction period. We have also published a [paper](https://doi.org/10.21105/joss.06889) in the Journal of Open Source Software (see citation further below).
+
+From this point forward, `scores` will be following the [Semantic Versioning Specification](https://semver.org/) (SemVer) in its release management. 
+
+This is a good moment to acknowledge and thank the contributors that helped us reach this point. They are: Tennessee Leeuwenburg, Nicholas Loveday, Elizabeth E. Ebert, Harrison Cook, Mohammadreza Khanarmuei, Robert J. Taggart, Nikeeth Ramanathan, Maree Carroll, Stephanie Chong, Aidan Griffiths and John Sharples.
+
+Please consider a citation of our paper if you use our code. The citation is:
+
+Leeuwenburg, T., Loveday, N., Ebert, E. E., Cook, H., Khanarmuei, M., Taggart, R. J., Ramanathan, N., Carroll, M., Chong, S., Griffiths, A., & Sharples, J. (2024). scores: A Python package for verifying and evaluating models and predictions with xarray. *Journal of Open Source Software, 9*(99), 6889. [https://doi.org/10.21105/joss.06889](https://doi.org/10.21105/joss.06889)
+
+BibTeX:
+```
+@article{Leeuwenburg_scores_A_Python_2024,
+author = {Leeuwenburg, Tennessee and Loveday, Nicholas and Ebert, Elizabeth E. and Cook, Harrison and Khanarmuei, Mohammadreza and Taggart, Robert J. and Ramanathan, Nikeeth and Carroll, Maree and Chong, Stephanie and Griffiths, Aidan and Sharples, John},
+doi = {10.21105/joss.06889},
+journal = {Journal of Open Source Software},
+month = jul,
+number = {99},
+pages = {6889},
+title = {{scores: A Python package for verifying and evaluating models and predictions with xarray}},
+url = {https://joss.theoj.org/papers/10.21105/joss.06889},
+volume = {9},
+year = {2024}
+}
+```
+
+For the full details of all changes in this release, see the [GitHub commit history](https://github.com/nci/scores/compare/0.9.3...1.0.0). 
+
 ## Version 0.9.3 (July 9, 2024)
 
 For the full details of all changes in this release, see the [GitHub commit history](https://github.com/nci/scores/compare/0.9.2...0.9.3). Below are the changes we think users may wish to be aware of.

src/scores/__init__.py

@@ -13,7 +13,7 @@
 import scores.sample_data
 import scores.stats.statistical_tests  # noqa: F401
 
-__version__ = "0.9.3"
+__version__ = "1.0.0"
 
 __all__ = [
     "scores.categorical",