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]: lidar: A Python package for delineating nested surface depressions from digital elevation data #2965

Closed
59 of 60 tasks
whedon opened this issue Jan 15, 2021 · 70 comments
Closed
59 of 60 tasks
Assignees
Labels
accepted Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@whedon
Copy link

whedon commented Jan 15, 2021

Submitting author: @giswqs (Qiusheng Wu)
Repository: https://github.com/giswqs/lidar
Version: 0.6.1
Editor: @kbarnhart
Reviewers: @laijingtao, @cheginit, @amanaster2
Archive: 10.5281/zenodo.4571011

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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

@laijingtao & @cheginit & @amanaster2, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @kbarnhart 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

Review checklist for @laijingtao

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@giswqs) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @cheginit

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@giswqs) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @amanaster2

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@giswqs) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
@whedon
Copy link
Author

whedon commented Jan 15, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @laijingtao, @cheginit, @amanaster2 it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

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

@whedon commands

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

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 15, 2021

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

OK DOIs

- 10.1016/j.cageo.2005.11.002 is OK
- 10.1016/j.geomorph.2016.05.006 is OK
- 10.1007/s13157-015-0731-6 is OK
- 10.1080/13658816.2015.1038719 is OK
- 10.1111/1752-1688.12689 is OK
- 10.1080/13658810500433453 is OK
- 10.1080/13658816.2014.975715 is OK
- 10.1002/hyp.10648 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.7717/peerj.453 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.7287/peerj.preprints.27099v1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Jan 15, 2021

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

@kbarnhart
Copy link

It looks like I accidentally unassigned the reviewers so I'm going to re-add them with whedon.

@kbarnhart
Copy link

@whedon add @laijingtao as reviewer

@whedon whedon assigned cheginit and kbarnhart and unassigned kbarnhart Jan 15, 2021
@whedon
Copy link
Author

whedon commented Jan 15, 2021

OK, @laijingtao is now a reviewer

@kbarnhart
Copy link

@whedon add @cheginit as reviewer

@whedon whedon assigned cheginit and kbarnhart and unassigned kbarnhart and cheginit Jan 15, 2021
@whedon
Copy link
Author

whedon commented Jan 15, 2021

OK, @cheginit is now a reviewer

@kbarnhart
Copy link

@whedon add @amanaster2 as reviewer

@whedon whedon assigned cheginit and kbarnhart and unassigned kbarnhart and cheginit Jan 15, 2021
@whedon
Copy link
Author

whedon commented Jan 15, 2021

OK, @amanaster2 is now a reviewer

@laijingtao
Copy link

Hi Katy @kbarnhart, it seems that I can't click the checkbox and my names is not listed as one of the assignees. Also, I clicked the link for accepting invitation but it said that it could find the invitation. This is my first time reviewing for joss. Could you help me figure out what could be wrong?

@kbarnhart
Copy link

@whedon re-invite @laijingtao as reviewer

@whedon
Copy link
Author

whedon commented Mar 1, 2021

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

@kbarnhart
Copy link

@giswqs please fix the .bib file so John B Lindsay and J B Lindsay are not disambiguated. This occurs when the author names are different. If you make all of them "Lindsay, J B" it should fix it.

Once you have made that fix and verified that it builds correctly as a PDF, please do the following:

  • Make a tagged release of your software, and list the version tag of the archived version here.
  • Archive the reviewed software in Zenodo or a similar service (e.g., figshare, an institutional repository)
  • Check the archival deposit (e.g., in Zenodo) has the correct metadata. This includes the title (should match the paper title) and author list (make sure the list is correct and people who only made a small fix are not on it). You may also add the authors' ORCID.
  • Please list the DOI of the archived version here.

I can then move forward with accepting the submission.

@giswqs
Copy link

giswqs commented Mar 1, 2021

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Mar 1, 2021

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

@giswqs
Copy link

giswqs commented Mar 1, 2021

@kbarnhart I have fixed the paper.bib file. See the article proof. Thanks.

@kbarnhart
Copy link

@whedon set 0.6.1 as version

@whedon
Copy link
Author

whedon commented Mar 2, 2021

OK. 0.6.1 is the version.

@kbarnhart
Copy link

@whedon set 10.5281/zenodo.4571011 as archive

@whedon
Copy link
Author

whedon commented Mar 2, 2021

OK. 10.5281/zenodo.4571011 is the archive.

@kbarnhart
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Mar 2, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Mar 2, 2021
@whedon
Copy link
Author

whedon commented Mar 2, 2021

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

OK DOIs

- 10.1016/j.cageo.2005.11.002 is OK
- 10.1016/j.geomorph.2016.05.006 is OK
- 10.1007/s13157-015-0731-6 is OK
- 10.1080/13658816.2015.1038719 is OK
- 10.1111/1752-1688.12689 is OK
- 10.1080/13658810500433453 is OK
- 10.1080/13658816.2014.975715 is OK
- 10.1002/hyp.10648 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.7717/peerj.453 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.7287/peerj.preprints.27099v1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@kbarnhart
Copy link

@giswqs I've now recommended that this submission be accepted and published. One of the JOSS EiC's @openjournals/joss-eics will manage final publication steps.

Thanks to @laijingtao @cheginit and @amanaster2 for contributing reviews.

@whedon
Copy link
Author

whedon commented Mar 2, 2021

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#2128

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2128, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@danielskatz
Copy link

@whedon accept deposit=true

@whedon whedon added accepted published Papers published in JOSS labels Mar 2, 2021
@whedon
Copy link
Author

whedon commented Mar 2, 2021

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

@whedon
Copy link
Author

whedon commented Mar 2, 2021

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

@whedon
Copy link
Author

whedon commented Mar 2, 2021

🚨🚨🚨 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.02965 joss-papers#2129
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.02965
  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...

@danielskatz
Copy link

Congratulations to @giswqs (Qiusheng Wu)!!

And thanks to @laijingtao, @cheginit, and @amanaster2 for reviewing, and @kbarnhart for editing!

@whedon
Copy link
Author

whedon commented Mar 2, 2021

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

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

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

This is how it will look in your documentation:

DOI

We need your help!

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:

@giswqs
Copy link

giswqs commented Mar 2, 2021

@kbarnhart Thank you very much for handling my submission. Much appreciated.

@laijingtao @cheginit and @amanaster2 Thank you all for your constructive comments that greatly improved the package.

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 Python recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Development

No branches or pull requests

7 participants