[REVIEW]: Pybotics: Python Toolbox for Robotics

whedon commented 5 years ago

Submitting author: @nnadeau (Nicholas A. Nadeau) Repository: https://github.com/nnadeau/pybotics Version: 0.7.1 Editor: @kyleniemeyer Reviewer: @adi3, @CameronDevine Archive: 10.5281/zenodo.3464685

Status

Status badge code:

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

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

@adi3 & @CameronDevine, 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 @kyleniemeyer know.

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

Review checklist for @adi3

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@nnadeau) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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 @CameronDevine

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@nnadeau) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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 commented 4 years ago

:point_right: Check article proof :page_facing_up: :point_left:

engnadeau commented 4 years ago

@whedon check references

whedon commented 4 years ago

Attempting to check references...

whedon commented 4 years ago


OK DOIs

- 10.3390/robotics8020033 is OK
- 10.1007/978-3-319-54413-7 is OK
- 10.1109/MCSE.2011.37 is OK
- 10.1109/IROS.2018.8593598 is OK

MISSING DOIs

- https://doi.org/10.1109/jra.1987.1087086 may be missing for title: Introduction to Robotics Mechanics and Control

INVALID DOIs

- None

kyleniemeyer commented 4 years ago

@nnadeau thanks! The SciPy citation is still not quite right, since our template doesn't play well with the recommended year format. Perhaps just change it to "2001" ?

engnadeau commented 4 years ago

@whedon generate pdf

whedon commented 4 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 4 years ago

:point_right: Check article proof :page_facing_up: :point_left:

engnadeau commented 4 years ago

@kyleniemeyer done

kyleniemeyer commented 4 years ago

@whedon accept

whedon commented 4 years ago

No archive DOI set. Exiting...

kyleniemeyer commented 4 years ago

ah, whoops! @nnadeau, please archive your repo using a service such as Zenodo, and let me know what the associated DOI is.

engnadeau commented 4 years ago

@kyleniemeyer

Bumped release to 0.7.2 (includes all changes from this review process)
Fixed the the Zenodo integration (https://zenodo.org/record/3464672)
Added DOI badge (https://github.com/nnadeau/pybotics/commit/43caa8de6bdb76e7aecc23e7d46e35e26f8f0834)
DOI = 10.5281/zenodo.3464672

kyleniemeyer commented 4 years ago

@whedon set 10.5281/zenodo.3464672 as archive

whedon commented 4 years ago

OK. 10.5281/zenodo.3464672 is the archive.

kyleniemeyer commented 4 years ago

@nnadeau sorry to drag this out, but it looks like you released v0.7.3—should that be what we use?

engnadeau commented 4 years ago

@kyleniemeyer sure! that was outside the scope of this review process (i.e., travis CI update), but sure, go ahead!

DOI: 10.5281/zenodo.3464685

kyleniemeyer commented 4 years ago

@whedon set 10.5281/zenodo.3464685 as archive

whedon commented 4 years ago

OK. 10.5281/zenodo.3464685 is the archive.

kyleniemeyer commented 4 years ago

@whedon accept

whedon commented 4 years ago

Attempting dry run of processing paper acceptance...

whedon commented 4 years ago


OK DOIs

- 10.3390/robotics8020033 is OK
- 10.1007/978-3-319-54413-7 is OK
- 10.1109/MCSE.2011.37 is OK
- 10.1109/IROS.2018.8593598 is OK

MISSING DOIs

- https://doi.org/10.1109/jra.1987.1087086 may be missing for title: Introduction to Robotics Mechanics and Control

INVALID DOIs

- None

whedon commented 4 years ago

Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/990

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

@whedon accept deposit=true

engnadeau commented 4 years ago

@kyleniemeyer looks good! Thank you everyone for this review process.

kyleniemeyer commented 4 years ago

@whedon accept deposit=true

whedon commented 4 years ago

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

whedon commented 4 years ago

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

whedon commented 4 years ago

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/991
Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01738
If everything looks good, then close this review issue.
Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? notify your editorial technical team...

kyleniemeyer commented 4 years ago

Congrats @nnadeau on your article's publication in JOSS! Thanks to @adi3 and @CameronDevine for reviewing!

whedon commented 4 years ago

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

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

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

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

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:

Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://joss.theoj.org/reviewer-signup.html
Making a small donation to support our running costs here: https://numfocus.salsalabs.org/donate-to-joss

openjournals / joss-reviews