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.

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

[REVIEW]: xclim: xarray-based climate data analytics #5415

Closed
editorialbot opened this issue Apr 27, 2023 · 54 comments
Closed

[REVIEW]: xclim: xarray-based climate data analytics #5415

editorialbot opened this issue Apr 27, 2023 · 54 comments
Assignees
Labels
accepted Makefile published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python review TeX Track: 6 (ESE) Earth Sciences and Ecology

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Apr 27, 2023

Submitting author: @Zeitsperre (Trevor James Smith)
Repository: https://github.com/Ouranosinc/xclim
Branch with paper.md (empty if default branch): joss_submission
Version: v0.43.0
Editor: @kthyng
Reviewers: @kthyng
Archive: 10.5281/zenodo.7916446

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/9cbcdf32aad971f794cc50f812a46c5f"><img src="https://joss.theoj.org/papers/9cbcdf32aad971f794cc50f812a46c5f/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/9cbcdf32aad971f794cc50f812a46c5f/status.svg)](https://joss.theoj.org/papers/9cbcdf32aad971f794cc50f812a46c5f)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@kthyng, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @kthyng know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Checklists

@kthyng, please create your checklist typing: @editorialbot generate my checklist

@editorialbot editorialbot added Makefile pyOpenSci Submissions associated with pyOpenSci Python review TeX Track: 6 (ESE) Earth Sciences and Ecology labels Apr 27, 2023
@editorialbot
Copy link
Collaborator Author

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.53 s (376.3 files/s, 134036.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         115           8739          13760          30495
YAML                            28             71             40           2826
reStructuredText                20            689            624           1852
TeX                              2            138              0           1851
Jupyter Notebook                19              0           5709           1722
JSON                             3              0              0           1331
SVG                              3              0              0            936
Markdown                         4             68              0            195
TOML                             1             12              3            176
make                             2             30              6             99
INI                              1              6             13             91
CSS                              1             13              3             51
DOS Batch                        1              8              1             27
HTML                             1              0              0              2
-------------------------------------------------------------------------------
SUM:                           201           9774          20159          41654
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1086

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.5194/gmd-10-4619-2017 is OK
- 10.5334/jors.148 is OK
- 10.1002/essoar.10510291.1 is OK
- 10.5281/zenodo.7382653 is OK
- 10.5065/D6WW7G29 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@kthyng
Copy link

kthyng commented Apr 27, 2023

Here is the pyOpenSci review issue, where this submission was already reviewed: pyOpenSci/software-submission#73

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@kthyng
Copy link

kthyng commented Apr 27, 2023

Paper looks good ✅

@Zeitsperre Do you have a Zenodo archive associated with your pyOpenSci review?

@Zeitsperre
Copy link

Hi @kthyng

Please excuse the late response (I was on vacation).

We have a permanent Zenodo DOI, but the last version does not yet include the pyOpenSci-approved build version (we are releasing a new version on 5 May). When released, it should be available automatically and immediately here: https://zenodo.org/record/7796479

@kthyng
Copy link

kthyng commented May 8, 2023

Hi @Zeitsperre! We should associate the DOI associated with the pyOpenSci review with the JOSS paper, so it looks like we need to wait for that? Also we request for JOSS submissions that the metadata for that archive be altered so that the title and author list exactly match the JOSS paper (looks more polished that way) — could you do that for the upcoming release?

@Zeitsperre
Copy link

@kthyng Sure thing!

We'll be releasing a new version this week, either tomorrow or Wednesday. I can make those changes before then.

@Zeitsperre
Copy link

@kthyng

We've just released a new version of xclim on PyPI (conda-forge later today) and have synchronized the authorship for Zenodo and the paper submission. Let me know if there's anything else that needs doing on my end.

Thanks!

@kthyng
Copy link

kthyng commented May 15, 2023

Hi @Zeitsperre! Is this the DOI you wanted? 10.5281/zenodo.7916446 and if so can you update so the title match?

@kthyng
Copy link

kthyng commented May 15, 2023

And the author list I guess? It is a lot longer on Zenodo than on the paper.

@Zeitsperre
Copy link

Hi @kthyng,

I don't think I have control over the title and information generated by @editorialbot, but yes, we would be submitting v0.43.0. I imagine that for the DOI, you need the static DOI to v0.43.0? In that case, yes, 10.5281/zenodo.7916446 looks good.

It's unfortunate, but the Zenodo and paper references were only synchronized in the branch containing the paper (https://github.com/Ouranosinc/xclim/tree/joss_submission). I'm not sure if this is a blocker for the review moving forward.

@kthyng
Copy link

kthyng commented May 15, 2023

@Zeitsperre I'm not sure we're talking about the same thing — let me try again. As you said, yes we want to have a specific match from your code as a release to the JOSS paper since of course the code is changing over time but a specific version was reviewed. But for that specific Zenodo release we prefer to have the title in the metadata match your JOSS paper and your author list match the JOSS paper, if possible (not required). I believe you can edit the metadata by hand for a specific version even if normally it is done automatically. So I would be looking for the author list and title to match your JOSS paper for this archive version: https://zenodo.org/record/7916446#.ZGJMNuzMLlw

But, if it isn't possible or you don't want to, let me know. And sorry if you are addressing this but I'm just not understanding!

@Zeitsperre
Copy link

Ah, I think I understand now. We release fairly regularly, so we tend to simply name our releases with the version numbers, but I see now that we can rename v0.43.0 on Zenodo with the title as written in the paper. Thanks for your patience!

For the author list, it would be great to have the author order as listed in the paper. I'll see if I can update this list momentarily.

@Zeitsperre
Copy link

@kthyng Changes have been made to the Zenodo entry. Thanks again for the clairifications!

@kthyng
Copy link

kthyng commented May 15, 2023

@Zeitsperre Title looks good! But, the author list doesn't match? I know it is tricky when you have your author list match the JOSS paper?

@Zeitsperre
Copy link

My bad! I'll double-check. Please excuse my errors!

@Zeitsperre
Copy link

Zeitsperre commented May 15, 2023

@kthyng I just checked again, and I think these are in sync.

From the paper (affiliations omitted for readability):

 - name: Pascal Bourgault
 - name: David Huard
 - name: Trevor James Smith
 - name: Travis Logan
 - name: Abel Aoun
 - name: Juliette Lavoie
 - name: Éric Dupuis
 - name: Gabriel Rondeau-Genessse
 - name: Raquel Alegre
 - name: Clair Barnes
 - name: Alexis Beaupré Laperrière
 - name: Sébastien Biner
 - name: David Caron
 - name: Carsten Ehbrecht
 - name: Jeremy Fyke
 - name: Tom Keel
 - name: Marie-Pier Labonté
 - name: Ludwig Lierhammer
 - name: Jwen-Fai Low
 - name: Jamie Quinn
 - name: Philippe Roy
 - name: Dougie Squire
 - name: Ag Stephens
 - name: Maliko Tanguy
 - name: Christopher Whelan

On Zenodo:
image

For each version, we also list the names of the contributors that added code specifically for that release, so this list will be much shorter, i.e.:

image

Could that be the source of confusion?

@kthyng
Copy link

kthyng commented May 15, 2023

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

@kthyng
Copy link

kthyng commented May 18, 2023

@editorialbot set v0.43.0 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v0.43.0

@kthyng
Copy link

kthyng commented May 18, 2023

@Zeitsperre Sorry for all the delays, we are ready to finish now!

@kthyng
Copy link

kthyng commented May 18, 2023

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

Doing it live! Attempting automated processing of paper acceptance...

@editorialbot
Copy link
Collaborator Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: Bourgault
  given-names: Pascal
  orcid: "https://orcid.org/0000-0003-1192-0403"
- family-names: Huard
  given-names: David
  orcid: "https://orcid.org/0000-0003-0311-5498"
- family-names: Smith
  given-names: Trevor James
  orcid: "https://orcid.org/0000-0001-5393-8359"
- family-names: Logan
  given-names: Travis
  orcid: "https://orcid.org/0000-0002-2212-9580"
- family-names: Aoun
  given-names: Abel
  orcid: "https://orcid.org/0000-0003-2289-2890"
- family-names: Lavoie
  given-names: Juliette
  orcid: "https://orcid.org/0000-0002-4708-5182"
- family-names: Dupuis
  given-names: Éric
  orcid: "https://orcid.org/0000-0001-7976-4596"
- family-names: Rondeau-Genesse
  given-names: Gabriel
  orcid: "https://orcid.org/0000-0003-3389-9406"
- family-names: Alegre
  given-names: Raquel
  orcid: "https://orcid.org/0000-0002-6081-0721"
- family-names: Barnes
  given-names: Clair
  orcid: "https://orcid.org/0000-0002-7806-7913"
- family-names: Laperrière
  given-names: Alexis Beaupré
- family-names: Biner
  given-names: Sébastien
  orcid: "https://orcid.org/0000-0001-7515-490X"
- family-names: Caron
  given-names: David
- family-names: Ehbrecht
  given-names: Carsten
- family-names: Fyke
  given-names: Jeremy
  orcid: "https://orcid.org/0000-0002-4522-3019"
- family-names: Keel
  given-names: Tom
  orcid: "https://orcid.org/0000-0001-9193-5271"
- family-names: Labonté
  given-names: Marie-Pier
  orcid: "https://orcid.org/0000-0003-0738-3940"
- family-names: Lierhammer
  given-names: Ludwig
  orcid: "https://orcid.org/0000-0002-7207-0003"
- family-names: Low
  given-names: Jwen-Fai
  orcid: "https://orcid.org/0000-0001-6618-7443"
- family-names: Quinn
  given-names: Jamie
- family-names: Roy
  given-names: Philippe
  orcid: "https://orcid.org/0000-0003-1239-7589"
- family-names: Squire
  given-names: Dougie
  orcid: "https://orcid.org/0000-0003-3271-6874"
- family-names: Stephens
  given-names: Ag
  orcid: "https://orcid.org/0000-0002-1038-7988"
- family-names: Tanguy
  given-names: Maliko
  orcid: "https://orcid.org/0000-0002-1516-6834"
- family-names: Whelan
  given-names: Christopher
contact:
- family-names: Logan
  given-names: Travis
  orcid: "https://orcid.org/0000-0002-2212-9580"
doi: 10.5281/zenodo.7916446
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Bourgault
    given-names: Pascal
    orcid: "https://orcid.org/0000-0003-1192-0403"
  - family-names: Huard
    given-names: David
    orcid: "https://orcid.org/0000-0003-0311-5498"
  - family-names: Smith
    given-names: Trevor James
    orcid: "https://orcid.org/0000-0001-5393-8359"
  - family-names: Logan
    given-names: Travis
    orcid: "https://orcid.org/0000-0002-2212-9580"
  - family-names: Aoun
    given-names: Abel
    orcid: "https://orcid.org/0000-0003-2289-2890"
  - family-names: Lavoie
    given-names: Juliette
    orcid: "https://orcid.org/0000-0002-4708-5182"
  - family-names: Dupuis
    given-names: Éric
    orcid: "https://orcid.org/0000-0001-7976-4596"
  - family-names: Rondeau-Genesse
    given-names: Gabriel
    orcid: "https://orcid.org/0000-0003-3389-9406"
  - family-names: Alegre
    given-names: Raquel
    orcid: "https://orcid.org/0000-0002-6081-0721"
  - family-names: Barnes
    given-names: Clair
    orcid: "https://orcid.org/0000-0002-7806-7913"
  - family-names: Laperrière
    given-names: Alexis Beaupré
  - family-names: Biner
    given-names: Sébastien
    orcid: "https://orcid.org/0000-0001-7515-490X"
  - family-names: Caron
    given-names: David
  - family-names: Ehbrecht
    given-names: Carsten
  - family-names: Fyke
    given-names: Jeremy
    orcid: "https://orcid.org/0000-0002-4522-3019"
  - family-names: Keel
    given-names: Tom
    orcid: "https://orcid.org/0000-0001-9193-5271"
  - family-names: Labonté
    given-names: Marie-Pier
    orcid: "https://orcid.org/0000-0003-0738-3940"
  - family-names: Lierhammer
    given-names: Ludwig
    orcid: "https://orcid.org/0000-0002-7207-0003"
  - family-names: Low
    given-names: Jwen-Fai
    orcid: "https://orcid.org/0000-0001-6618-7443"
  - family-names: Quinn
    given-names: Jamie
  - family-names: Roy
    given-names: Philippe
    orcid: "https://orcid.org/0000-0003-1239-7589"
  - family-names: Squire
    given-names: Dougie
    orcid: "https://orcid.org/0000-0003-3271-6874"
  - family-names: Stephens
    given-names: Ag
    orcid: "https://orcid.org/0000-0002-1038-7988"
  - family-names: Tanguy
    given-names: Maliko
    orcid: "https://orcid.org/0000-0002-1516-6834"
  - family-names: Whelan
    given-names: Christopher
  date-published: 2023-05-18
  doi: 10.21105/joss.05415
  issn: 2475-9066
  issue: 85
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5415
  title: "xclim: xarray-based climate data analytics"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05415"
  volume: 8
title: "xclim: xarray-based climate data analytics"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.05415 joss-papers#4245
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05415
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels May 18, 2023
@Zeitsperre
Copy link

@kthyng This is fantastic news! Thanks for much for your help! I can't wait to announce it!

I had one author mention late this morning that they'd like their affiliation updated if possible. If it's too late, not a problem.

All the best,
Trevor

@kthyng
Copy link

kthyng commented May 18, 2023

Congrats on your new publication @Zeitsperre!!

@kthyng
Copy link

kthyng commented May 18, 2023

ok you should be able to update your paper and then we can accept it again.

@Zeitsperre
Copy link

Zeitsperre commented May 18, 2023

@kthyng

OK! We are ready (for real this time)! Thanks again!

@kthyng
Copy link

kthyng commented May 18, 2023

@editorialbot re-accept

@editorialbot
Copy link
Collaborator Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

@kthyng
Copy link

kthyng commented May 18, 2023

@editorialbot reaccept

@editorialbot
Copy link
Collaborator Author

Rebuilding paper!

@editorialbot
Copy link
Collaborator Author

🌈 Paper updated!

New PDF and metadata files 👉 openjournals/joss-papers#4246

@kthyng
Copy link

kthyng commented May 18, 2023

@Zeitsperre could you take a look and see if it is fixed?

@Zeitsperre
Copy link

Yes! Everything looks good! Thanks so much!

@kthyng
Copy link

kthyng commented May 18, 2023

Ok great, I'll close this issue now. Congrats again! I'm sharing your package with colleagues since it looks really useful!

@kthyng kthyng closed this as completed May 18, 2023
@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05415/status.svg)](https://doi.org/10.21105/joss.05415)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.05415">
  <img src="https://joss.theoj.org/papers/10.21105/joss.05415/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.05415/status.svg
   :target: https://doi.org/10.21105/joss.05415

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

Zeitsperre added a commit to Ouranosinc/xclim that referenced this issue May 19, 2023
### What kind of change does this PR introduce?

This PR finalizes the submission and publishing steps for the [Journal
of Open Source
Software](https://joss.readthedocs.io/en/latest/index.html). The paper
is expected to have a length of 250 - 1000 words and demands that the
software is *feature-complete*. As such, the submission process should
not be started until we have at the very least added all necessary
indicators from our backlog and/or stabilized our API (i.e.: v1.0-alpha
or release-candidate).

Updates (May 2023): 
With xclim v0.40.0, the software was deemed ready for submission. The
review process for JOSS was completed via PyOpenSci
(pyOpenSci/software-submission#73), and the
final JOSS review was performed in
openjournals/joss-reviews#5415. The software
(v0.43.0) and paper were published on 18 May 2023
(https://doi.org/10.21105/joss.05415).

### Does this PR introduce a breaking change?

No.

---------

Co-authored-by: Philippe Roy <[email protected]>
Co-authored-by: David Huard <[email protected]>
Co-authored-by: Abel Aoun <[email protected]>
Co-authored-by: Pascal Bourgault <[email protected]>
Co-authored-by: tlogan2000 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Makefile published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python review TeX Track: 6 (ESE) Earth Sciences and Ecology
Projects
None yet
Development

No branches or pull requests

3 participants