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]: Museo ToolBox : a python library for remote sensing including a new way to handle rasters. #1978

Closed
38 tasks done
whedon opened this issue Dec 20, 2019 · 85 comments
Closed
38 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Dec 20, 2019

Submitting author: @nkarasiak (Nicolas Karasiak)
Repository: https://github.com/nkarasiak/MuseoToolBox
Version: v0.13.0
Editor: @kbarnhart
Reviewer: @cmillion, @mollenburger
Archive: 10.5281/zenodo.3759215

Status

status

Status badge code:

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

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

@cmillion & @mollenburger, 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 try and complete your review in the next two weeks

Review checklist for @cmillion

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 (@nkarasiak) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 @mollenburger

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 (@nkarasiak) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 Dec 20, 2019

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

⭐ 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 Dec 20, 2019

Attempting to check references...

@whedon
Copy link
Author

whedon commented Dec 20, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Dec 20, 2019


OK DOIs

- 10.3390/rs11212512 is OK
- 10.1111/ecog.02881 is OK
- 10.1016/j.rse.2014.02.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Dec 20, 2019

@kbarnhart
Copy link

👋 @nkarasiak, @cmillion, @mollenburger this is the review thread for the paper. All of our communications will happen here from now on.

All reviewers have checklists at the top of this thread with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#1978 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. I understand that it is late December and many people may be taking vacation and/or spending time away from work. We can also use Whedon (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@kbarnhart) if you have any questions/concerns.

@kbarnhart
Copy link

👋 @cmillion, @mollenburger, just a quick reminder to complete your reviews. As always, if you have any questions, please feel free to ping me here.

@kbarnhart
Copy link

👋 @cmillion, @mollenburger I wanted to check in to remind you to complete your reviews. As always, if you have any questions, please feel free to ping me here.

@cmillion
Copy link

Confirming.

@kbarnhart
Copy link

@cmillion thanks for confirming.

@kbarnhart
Copy link

👋 @cmillion, @mollenburger A friendly reminder to complete your reviews. If you have an estimated timeline, please let me know.

@mollenburger could you please confirm receipt.

As always, if you have any questions, please feel free to ping me here.

Thank you for being willing to review for JOSS.

@mollenburger
Copy link

confirming. I'm working on this today and hope to have it done by the end of the week.

@kbarnhart
Copy link

👋 @cmillion, @mollenburger a friendly reminder to complete your reviews.

If you create any issues in the submitted repository, please link to this issue by using /issues/1978

When you are done, please make a note here on this issue indicating your recommendation.

If you have any questions, please let me know.

@kbarnhart
Copy link

I wanted to check in to keep this review moving along.

I see that there are open issues in the main repository made by @cmillion, Thank you for making issues there.

This ping is meant as a reminder to the reviewers to make any additional issues that stand in the way of completing the review checklist, and as a reminder to @nkarasiak to address issues.

Thanks again to all for contributing to the JOSS review process.

@kbarnhart
Copy link

👋 another message to check in and keep this review moving forward. I see that both @cmillion and @mollenburger have made issues in the main repo (thanks 👍 ). Based on looking at them it appears that some of the issues may need to be addressed before the reviewers can complete their reviews.

@nkarasiak can I ping you to address these issues so the reviewers can complete their reviews.

@nkarasiak
Copy link

nkarasiak commented Feb 17, 2020

Of course @kbarnhart, what do I need to do (except addressing the issues) ?
I was preparing my answers (and code/text rewriting) for the reviewers, and a native English speaker is going to proofread my paper.

@kbarnhart
Copy link

thanks for the quick reply @nkarasiak. Just addressing the issues is fine.

@kbarnhart
Copy link

👋 @nkarasiak I wanted to check in and see if you had an anticipated timeline for addressing the current set of issues.

@nkarasiak
Copy link

Hello @kbarnhart. I'm dealing with the issues, and I submitted my library to conda in order to answer to @mollenburger to ease the installation process with gdal but it takes some times...
I didn't forget to answers the issues, I just want to do it the nicest way possible :)
I hope end of next week everything will be adressed.
Kind regards,
Nicolas.

@ooo
Copy link

ooo bot commented Feb 27, 2020

👋 Hey @nkarasiak...

Letting you know, @kbarnhart is currently OOO until Friday, March 20th 2020. ❤️

@kbarnhart
Copy link

@nkarasiak thanks for the update. It all sounds good.

Also, sorry for the ooo-bot, I accidentally turned it on trying to demonstrate how to use it for a reviewer (and I haven't yet figured out how to turn it off). I'm not out of the office at all.

@kbarnhart
Copy link

@nkarasiak I wanted to check in on this review. Could you provide an update on your progress addressing the current set of issues raised by the reviewers?

@kbarnhart
Copy link

@nkarasiak once you have considered nkarasiak/MuseoToolBox/pull/29 and updated the repositories master branch could you:

  • Make a tagged release of your software, and indicate 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

@nkarasiak
Copy link

Hi @kbarnhart
I updated and published the 0.13.0 version in the master branch :

  • The git tagged version is 0.13.0.
  • The Zenodo archive version is also 0.13.0 with the DOI 10.5281/zenodo.3759215. Author list, title and ORCID have been added in the archive deposit.

@kbarnhart
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Apr 21, 2020

Reference check summary:

OK DOIs

- 10.2307/2332142 is OK
- 10.3390/rs11212512 is OK
- 10.1111/ecog.02881 is OK
- 10.1016/j.rse.2014.02.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@kbarnhart
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Apr 21, 2020

@kbarnhart
Copy link

@whedon set v0.13.0 as version

@whedon
Copy link
Author

whedon commented Apr 21, 2020

OK. v0.13.0 is the version.

@kbarnhart
Copy link

@whedon set 10.5281/zenodo.3759215 as archive

@whedon
Copy link
Author

whedon commented Apr 21, 2020

OK. 10.5281/zenodo.3759215 is the archive.

@kbarnhart
Copy link

kbarnhart commented Apr 21, 2020

@nkarasiak I'm going to move this article to the final stage by notifying the JOSS editors in chief that it is ready to be published. They may or may not have have additional requests of you.

@kbarnhart
Copy link

@whedon accept

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Apr 21, 2020
@whedon
Copy link
Author

whedon commented Apr 21, 2020

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Apr 21, 2020

Reference check summary:

OK DOIs

- 10.2307/2332142 is OK
- 10.3390/rs11212512 is OK
- 10.1111/ecog.02881 is OK
- 10.1016/j.rse.2014.02.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 21, 2020

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

Check final proof 👉 openjournals/joss-papers#1426

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

@whedon accept deposit=true

@arfon
Copy link
Member

arfon commented Apr 21, 2020

@whedon accept deposit=true

@arfon
Copy link
Member

arfon commented Apr 21, 2020

@whedon commands

1 similar comment
@arfon
Copy link
Member

arfon commented Apr 21, 2020

@whedon commands

@whedon
Copy link
Author

whedon commented Apr 21, 2020

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

@whedon whedon added accepted published Papers published in JOSS labels Apr 21, 2020
@whedon
Copy link
Author

whedon commented Apr 21, 2020

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

@whedon
Copy link
Author

whedon commented Apr 21, 2020

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

@openjournals openjournals deleted a comment from whedon Apr 21, 2020
@openjournals openjournals deleted a comment from whedon Apr 21, 2020
@arfon
Copy link
Member

arfon commented Apr 21, 2020

@cmillion, @mollenburger - many thanks for your reviews here and to @kbarnhart for editing this one ✨

@nkarasiak - your paper is now accepted into JOSS ⚡🚀💥

@arfon arfon closed this as completed Apr 21, 2020
@whedon
Copy link
Author

whedon commented Apr 21, 2020

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

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

6 participants