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]: QComms QKD Software Toolkit #1119

Open
whedon opened this issue Dec 7, 2018 · 23 comments

Comments

Projects
None yet
6 participants
@whedon
Copy link
Collaborator

commented Dec 7, 2018

Submitting author: @richardcollins (Richard Collins)
Repository: https://gitlab.com/QComms/cqptoolkit
Version: 0.3
Editor: @brainstorm
Reviewer: @ejdanderson
Archive: Pending

Status

status

Status badge code:

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

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) 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

@ejdanderson, 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.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @brainstorm know.

Please try and complete your review in the next two weeks

Review checklist for @ejdanderson

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: Does the release version given match the GitHub release (0.3)?
  • Authorship: Has the submitting author (@richardcollins) 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)?
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Dec 7, 2018

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @ejdanderson 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
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Dec 7, 2018

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Dec 7, 2018

@ejdanderson

This comment has been minimized.

Copy link
Collaborator

commented Dec 7, 2018

@whedon commands

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Dec 7, 2018

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Compile the paper
@whedon generate pdf

@brainstorm

This comment has been minimized.

Copy link
Member

commented Dec 7, 2018

@ejdanderson You might want to have a look at https://joss.readthedocs.io/en/latest/review_criteria.html for some guidance on how to tick the boxes above, let me know if you have any doubts about the process. When in doubt, you can check other issues in this same issue tracker and see how different software reviews went, thanks again for your efforts!

@brainstorm

This comment has been minimized.

Copy link
Member

commented Dec 16, 2018

👋 @ejdanderson Let me know if you have any doubts on how to proceed :)

@ejdanderson

This comment has been minimized.

Copy link
Collaborator

commented Dec 19, 2018

Great thanks! I'll have time this weekend to review.

@ejdanderson

This comment has been minimized.

Copy link
Collaborator

commented Dec 23, 2018

@brainstorm There appears to be plenty of documentation, tests, and example programs to draw from for the software. Unfortunately, I imagine most people will be installing this via docker, which I was unable to do following the instructions (see Installation below).

Authorship:

  • Djeylan Aktas - It is unclear of Atkas’ contribution to the software. Are they an academic advisor?

Installation:

I have attempted to install this via the docker installation and was presented an error (even post typo fix) see issue 6.

Community guidelines:

It would be worthwhile to explicitly state how contributions, issues, and support can be made via the README. Either a separate contribution.md file (example) or a few lines in the README itself is recommended. I found the Coding.md file to be very informative, thank you for including this.

Software paper

  • @brainstorm Can you comment on the requirement of having a Summary heading? The introduction serves as a valid summary, but likely needs to be changed to "Summary"

  • Either expand the approach heading or remove it.

@brainstorm

This comment has been minimized.

Copy link
Member

commented Dec 24, 2018

@richardcollins, would you mind addressing the installation defects and authorship question pointed by @ejdanderson?

@ejdanderson, firstly thanks much for your review efforts so far! Regarding the community guidelines, I agree one could use what you point out and/or GitHub's builtin support for it. I do think that the "summary requirement" is already covered by the "Introduction" section in paper.md while I also agree that it should be hinted briefly on the README.md so that people exploring the repository can have a quick overview of the software repository.

@brainstorm

This comment has been minimized.

Copy link
Member

commented Jan 7, 2019

@richardcollins

This comment has been minimized.

Copy link

commented Jan 7, 2019

@richardcollins

This comment has been minimized.

Copy link

commented Jan 7, 2019

@ejdanderson I've changed the heading in the paper to Summary.
@brainstorm wrt the contributions, Djeylan and others have provided details on the algorithms and the technical aspects of QKD but havn't written code in this project - do I need to cite them in a different way?

@brainstorm

This comment has been minimized.

Copy link
Member

commented Jan 7, 2019

@richardcollins According to the JOSS reviewer guidelines you, as the author, take the responsibility for authorship claims, so thanks for stating it here, that should suffice AFAICT.

@ejdanderson Feel free to carry on with the remaining items whenever you can.

Cheers!

@ejdanderson

This comment has been minimized.

Copy link
Collaborator

commented Jan 8, 2019

Thanks, I'll take a look this week.

@brainstorm

This comment has been minimized.

Copy link
Member

commented Jan 21, 2019

@ejdanderson Let me know if you have any doubts regarding any of the review points, happy to help!

@brainstorm

This comment has been minimized.

Copy link
Member

commented Feb 11, 2019

👋 @ejdanderson, sorry to bother you with this, if it's tricky to test/install that's also a valid feedback for the author :)

@richardcollins

This comment has been minimized.

Copy link

commented Mar 8, 2019

@ejdanderson, Sorry to bug you about this but are you able to spend some time on this? - I'm happy to answer questions. I need to report my publications in a progress report and this has been noted as stalled.

@labarba

This comment has been minimized.

Copy link
Member

commented Mar 16, 2019

At this point, we're beset by a delinquent reviewer, and one possible course of action is to find a second reviewer who is willing to fast-track this submission.

@brainstorm — try to find someone willing to make such a contribution to JOSS. You'll need to manually edit the first post in this thread to add a new checklist for the reviewer. If they have already reviewed for JOSS, they will have permissions to tick off the items. If not, we'll have to add them as collaborator to the joss-reviews repo (which I think only @arfon can do).

@brainstorm

This comment has been minimized.

Copy link
Member

commented Mar 17, 2019

I'm contacting two additional quantum computing researchers through a common contact, hopefully they'll be able and willing to review and fast-track this paper. Thanks for your patience @richardcollins and @labarba for the additional editorial pointers, this is the first case of many papers that a reviewer went missing for me.

@brainstorm

This comment has been minimized.

Copy link
Member

commented Mar 19, 2019

Hello @arturgs, @brunojulia recommended you as a possible reviewer for this quantum key distribution paper, would you be interested in reviewing it? The process is fairly straightforward and semi-automated via GitHub:

https://joss.readthedocs.io/en/latest/reviewer_guidelines.html

Let me know if you are interested!

@brainstorm

This comment has been minimized.

Copy link
Member

commented Mar 31, 2019

Hello @SwamyDev, I peeked at your https://github.com/SwamyDev/q_network QKD framework and thought that you could assist JOSS (Journal of Open Source Software) on reviewing this software:

https://gitlab.com/QComms/cqptoolkit

The review process is held via this issue and here on Github, please let us know if you are interested in reviewing this software publication.

@danielskatz

This comment has been minimized.

Copy link

commented May 20, 2019

👋 @brainstorm - what's happening here? It looks like this has been waiting for a new reviewer for about 6 weeks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.