Skip to content

[REVIEW]: sbpy: A Python module for small-body planetary astronomy #1426

Closed

Description

@whedon

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

Status badge code:

HTML: <a href="http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060"><img src="http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060/status.svg"></a>
Markdown: [![status](http://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060/status.svg)](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:

  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 @xuanxu know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @Juanlu001

Conflict of interest

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.md file 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

  1. whedon commented on May 3, 2019

    @whedon
    Author

    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:

    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
    
  2. whedon commented on May 3, 2019

    @whedon
    Author
    Attempting PDF compilation. Reticulating splines etc...
    
  3. whedon commented on May 3, 2019

    @whedon
    Author
  4. astrojuanlu commented on May 3, 2019

    @astrojuanlu

    Before I finish a proper review:

    Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?

    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.

  5. mommermi commented on May 3, 2019

    @mommermi

    Hi @Juanlu001, thanks for reviewing this submission! Would you prefer the License.rst to be on the root level (probably makes more sense on the root level anyway...)?

  6. astrojuanlu commented on May 3, 2019

    @astrojuanlu

    I think so @mommermi! Having a LICENSE at the top (not sure about the extensions) makes it easier to spot and also GitHub can read the metadata from it.

  7. mommermi commented on May 3, 2019

    @mommermi

    Ok, done!
    I created a PR (NASA-Planetary-Science/sbpy#145) that will hold all the code changes from this review.

  8. mommermi commented on May 3, 2019

    @mommermi

    @whedon generate pdf

  9. whedon commented on May 3, 2019

    @whedon
    Author
    Attempting PDF compilation. Reticulating splines etc...
    
  10. whedon commented on May 3, 2019

    @whedon
    Author
  11. mommermi commented on May 3, 2019

    @mommermi

    @whedon generate pdf

  12. whedon commented on May 3, 2019

    @whedon
    Author
    Attempting PDF compilation. Reticulating splines etc...
    
  13. whedon commented on May 3, 2019

    @whedon
    Author
  14. 34 remaining items

  15. whedon commented on Jun 22, 2019

    @whedon
    Author
  16. danielskatz commented on Jun 22, 2019

    @danielskatz

    @whedon accept

  17. whedon commented on Jun 22, 2019

    @whedon
    Author
    Attempting dry run of processing paper acceptance...
    
  18. whedon commented on Jun 22, 2019

    @whedon
    Author
    
    OK DOIs
    
    - 10.1051/0004-6361/201322068 is OK
    - 10.3847/1538-3881/aabc4f is OK
    - 10.3847/1538-3881/aafc33 is OK
    
    MISSING DOIs
    
    - None
    
    INVALID DOIs
    
    - None
    
  19. whedon commented on Jun 22, 2019

    @whedon
    Author

    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=true e.g.

    @whedon accept deposit=true
    
  20. danielskatz commented on Jun 22, 2019

    @danielskatz

    @whedon accept deposit=true

  21. whedon commented on Jun 22, 2019

    @whedon
    Author
    Doing it live! Attempting automated processing of paper acceptance...
    
  22. whedon commented on Jun 22, 2019

    @whedon
    Author

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

  23. whedon commented on Jun 22, 2019

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

  24. whedon commented on Jun 22, 2019

    @whedon
    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](http://joss.theoj.org/papers/10.21105/joss.01426/status.svg)](https://doi.org/10.21105/joss.01426)
    
    HTML:
    <a style="border-width:0" href="https://doi.org/10.21105/joss.01426">
      <img src="http://joss.theoj.org/papers/10.21105/joss.01426/status.svg" alt="DOI badge" >
    </a>
    
    reStructuredText:
    .. image:: http://joss.theoj.org/papers/10.21105/joss.01426/status.svg
       :target: https://doi.org/10.21105/joss.01426
    

    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:

  25. danielskatz commented on Jun 22, 2019

    @danielskatz

    Thanks to @Juanlu001 for reviewing and @xuanxu for editing

  26. mommermi commented on Jun 22, 2019

    @mommermi

    Thank you all for the quick processing of this paper!

  27. added
    publishedPapers published in JOSS
    recommend-acceptPapers recommended for acceptance in JOSS.
    on Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions