Repository navigation
Description
Submitting author: @mommermi (Michael Mommert)
Repository: https://github.com/NASA-Planetary-Science/sbpy
Version: v0.1.1
Editor: @xuanxu
Reviewer: @Juanlu001
Archive: 10.5281/zenodo.3252172
Status
Status badge code:
HTML: <a href="http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060"><img src="http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060/status.svg"></a>
Markdown: [](http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060)
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
@Juanlu001, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
- Make sure you're logged in to your GitHub account
- 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 @xuanxu know.
✨ Please try and complete your review in the next two weeks ✨
Review checklist for @Juanlu001
Conflict of interest
- As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.
Code of Conduct
- I confirm that I read and will adhere to the JOSS 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?
- Version: v0.1.1
- Authorship: Has the submitting author (@mommermi) 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 function 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
- Authors: Does the
paper.mdfile include a list of authors with their affiliations? - A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
- References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
Activity
whedon commentedon May 3, 2019
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @Juanlu001 it looks like you're currently assigned as the reviewer for 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:
For a list of things I can do to help you, just type:
whedon commentedon May 3, 2019
whedon commentedon May 3, 2019
👉 Check article proof 📄 👈
astrojuanlu commentedon May 3, 2019
Before I finish a proper review:
The license is stated in the README and also in https://github.com/NASA-Planetary-Science/sbpy/blob/master/licenses/LICENSE.rst. Not what I expected, but I guess it should be enough.
mommermi commentedon May 3, 2019
Hi @Juanlu001, thanks for reviewing this submission! Would you prefer the
License.rstto be on the root level (probably makes more sense on the root level anyway...)?astrojuanlu commentedon May 3, 2019
I think so @mommermi! Having a
LICENSEat the top (not sure about the extensions) makes it easier to spot and also GitHub can read the metadata from it.mommermi commentedon May 3, 2019
Ok, done!
I created a PR (NASA-Planetary-Science/sbpy#145) that will hold all the code changes from this review.
mommermi commentedon May 3, 2019
@whedon generate pdf
whedon commentedon May 3, 2019
whedon commentedon May 3, 2019
👉 Check article proof 📄 👈
mommermi commentedon May 3, 2019
@whedon generate pdf
whedon commentedon May 3, 2019
whedon commentedon May 3, 2019
👉 Check article proof 📄 👈
34 remaining items
whedon commentedon Jun 22, 2019
👉 Check article proof 📄 👈
danielskatz commentedon Jun 22, 2019
@whedon accept
whedon commentedon Jun 22, 2019
whedon commentedon Jun 22, 2019
whedon commentedon Jun 22, 2019
Check final proof 👉 openjournals/joss-papers#788
If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#788, then you can now move forward with accepting the submission by compiling again with the flag
deposit=truee.g.danielskatz commentedon Jun 22, 2019
@whedon accept deposit=true
whedon commentedon Jun 22, 2019
whedon commentedon Jun 22, 2019
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦
whedon commentedon Jun 22, 2019
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨
Here's what you must now do:
Any issues? notify your editorial technical team...
whedon commentedon Jun 22, 2019
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉
If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation:
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:
danielskatz commentedon Jun 22, 2019
Thanks to @Juanlu001 for reviewing and @xuanxu for editing
mommermi commentedon Jun 22, 2019
Thank you all for the quick processing of this paper!