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]: Pyafscgap.org: Open source multi-modal Python-based tools for NOAA AFSC RACE GAP #5593

Closed
editorialbot opened this issue Jun 26, 2023 · 47 comments
Assignees
Labels
accepted Dockerfile published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python review Shell Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Jun 26, 2023

Submitting author: @sampottinger (A Samuel Pottinger)
Repository: https://github.com/SchmidtDSE/afscgap
Branch with paper.md (empty if default branch):
Version: 1.0.4
Editor: @Kevin-Mattheus-Moerman
Reviewers: @Kevin-Mattheus-Moerman
Archive: 10.5281/zenodo.8091843

Status

status

Status badge code:

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

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

@Kevin-Mattheus-Moerman, 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 @Kevin-Mattheus-Moerman 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

@Kevin-Mattheus-Moerman, please create your checklist typing: @editorialbot generate my checklist

@editorialbot editorialbot added Dockerfile pyOpenSci Submissions associated with pyOpenSci Python review Shell Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials labels Jun 26, 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.11 s (889.2 files/s, 204715.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             9              0              0           6657
Python                          29           1524           2993           3447
JavaScript                      14            535           1010           2327
Markdown                        16            364              0            993
CSS                              2            103              0            443
HTML                             6             16              0            392
SQL                             10              5              0            324
Jupyter Notebook                 1              0            894            191
TeX                              1             22              0            189
YAML                             4              8              2            162
SVG                              1              0              1             54
TOML                             1              5              0             54
Dockerfile                       1              9              8             28
Bourne Shell                     4              5              8             19
-------------------------------------------------------------------------------
SUM:                            99           2596           4916          15280
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1007

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1023/a:1016528631593 is OK

MISSING DOIs

- 10.1007/978-1-4842-6011-1_12 may be a valid DOI for title: Oracle Rest Data Services

INVALID DOIs

- None

@Kevin-Mattheus-Moerman
Copy link
Member

This is a pyopensci related submission which was reviewed here: pyOpenSci/software-submission#93

@editorialbot
Copy link
Collaborator Author

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

@Kevin-Mattheus-Moerman
Copy link
Member

@sampottinger please try to address the potentially missing DOI listed ☝️ , you can use @editorialbot check references to check the DOIs again.

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jun 26, 2023

@sampottinger I have checked your paper and noticed some minor typos, please address them, see below. I also recommend that you proof read your paper once more and amend where needed.

  • Please add California, United States of America to your affiliation
  • Fix compliation -> compilation
  • Fix compatability -> compatibility
  • Fix speices -> species
  • Fix synchoronous -> synchronous

Relating to the ZENODO archive:

  • Please edit it to ensure the title matches your paper title
  • Please edit it to ensure the license listed matches your software license

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jun 26, 2023

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
  • Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

  • Read the text of the paper and offer comments/corrections (as either a list or a PR)
  • Check the references in the paper for corrections (e.g. capitalization)
  • Check that the archive title, author list, version tag, and the license are correct
  • Set archive DOI with @editorialbot set <DOI here> as archive
  • Set version with @editorialbot set <version here> as version
  • Double check rendering of paper with @editorialbot generate pdf
  • Specifically check the references with @editorialbot check references and ask author(s) to update as needed
  • Recommend acceptance with @editorialbot recommend-accept

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 10.5281/zenodo.7991875 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.7991875

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 1.0.2 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now 1.0.2

@sampottinger
Copy link

Thanks for all of this @Kevin-Mattheus-Moerman!

some minor typos

Thank you for flagging those I’ll address shortly.

Relating to the ZENODO archive:

I’ll confirm these items shortly!

please try to address the potentially missing DOI listed

Thanks! ORDS does not have a DOI as far as I can tell. The one suggested is a book for Oracle Cloud Services. Please advise how you want to continue but the current citation may be best.

@Kevin-Mattheus-Moerman
Copy link
Member

@sampottinger On the DOI, if you believe not having the DOI is correct then just leave it the way it is.

@sampottinger
Copy link

Phenomenal! I’ll take care of the other items today or tomorrow. Thanks again!

@sampottinger
Copy link

@editorialbot set 1.0.3 as version

@editorialbot
Copy link
Collaborator Author

I'm sorry @sampottinger, I'm afraid I can't do that. That's something only editors are allowed to do.

@sampottinger
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1042

@sampottinger
Copy link

@editorialbot generate pdf

@sampottinger
Copy link

sampottinger commented Jun 28, 2023

Hello @Kevin-Mattheus-Moerman! Thank you for your comments. I have:

  • Addressed the typos you found. Appreciate it!
  • Updated our affiliations as you requested.
  • Corrected the zenodo metadata as you indicated.
  • Performed another read-through with minor expansion while still trying to remain close to the JOSS word count limits.

My apologies but can you please update the version to 1.0.4 (@editorialbot set 1.0.4 as version)? Thanks!

@editorialbot
Copy link
Collaborator Author

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

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1023/a:1016528631593 is OK

MISSING DOIs

- 10.1007/978-1-4842-6011-1_12 may be a valid DOI for title: Oracle Rest Data Services

INVALID DOIs

- None

@sampottinger
Copy link

(Sorry that DOI check keeps catching ORDS which doesn't have a DOI... the DOI it recommends is incorect)

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@sampottinger
Copy link

sampottinger commented Jun 28, 2023

@Kevin-Mattheus-Moerman - can you change to version 1.0.4 ?

Sorry I should have bolded that request in my earlier message. 😬 The only practical difference is a typo fix in the paper and correction of zenodo metadata.

@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: Pottinger
  given-names: A Samuel
  orcid: "https://orcid.org/0000-0002-0458-4985"
- family-names: Zarpellon
  given-names: Giulia
  orcid: "https://orcid.org/0000-0002-9122-4709"
doi: 10.5281/zenodo.7991875
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Pottinger
    given-names: A Samuel
    orcid: "https://orcid.org/0000-0002-0458-4985"
  - family-names: Zarpellon
    given-names: Giulia
    orcid: "https://orcid.org/0000-0002-9122-4709"
  date-published: 2023-06-28
  doi: 10.21105/joss.05593
  issn: 2475-9066
  issue: 86
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5593
  title: "Pyafscgap.org: Open source multi-modal Python-based tools for
    NOAA AFSC RACE GAP"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05593"
  volume: 8
title: "Pyafscgap.org: Open source multi-modal Python-based tools for
  NOAA AFSC RACE GAP"

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

🐘🐘🐘 👉 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.05593 joss-papers#4359
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05593
  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 Jun 28, 2023
@sampottinger
Copy link

sampottinger commented Jun 28, 2023

@Kevin-Mattheus-Moerman - My apologies we should be good to go... you can ignore my earlier message unless you want to update the reference here. We reference latest in linking to zenodo 10.5281/zenodo.7991875. Either way, thanks so much for your review!

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jun 29, 2023

@sampottinger it would be better to update the version and archive DOI here. We should be able to do that. Sorry I missed that in your comment!

@openjournals/dev @arfon can you help process the following changes for this paper:

@editorialbot set 1.0.4 as version
@editorialbot set 10.5281/zenodo.8091843 as archive

@xuanxu
Copy link
Member

xuanxu commented Jun 29, 2023

@Kevin-Mattheus-Moerman: Running those two commands to update the version and the archive values and then @editorialbot reaccept should work.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 1.0.4 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now 1.0.4

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 10.5281/zenodo.8091843 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.8091843

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot reaccept

@editorialbot
Copy link
Collaborator Author

Rebuilding paper!

@editorialbot
Copy link
Collaborator Author

🌈 Paper updated!

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

@Kevin-Mattheus-Moerman
Copy link
Member

@sampottinger this looks good to me now, and the paper available on the website points to the updated archive already. I'll close this issue now shortly. Congratulations again!

@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.05593/status.svg)](https://doi.org/10.21105/joss.05593)

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Dockerfile published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python review Shell Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

4 participants