Skip to content

[PRE REVIEW]: Singularity Registry: Open Source Registry for Singularity Images #419

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

Closed
whedon opened this issue Oct 1, 2017 · 13 comments
Closed
Assignees

Comments

@whedon
Copy link

whedon commented Oct 1, 2017

Submitting author: @vsoch (Vanessa Sochat)
Repository: https://www.github.com/singularityhub/sregistry
Version: v1.0.0
Editor: @pjotrp
Reviewer: @smoe

Author instructions

Thanks for submitting your paper to JOSS @vsoch. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@vsoch if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

The JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:

@whedon commands
@whedon
Copy link
Author

whedon commented Oct 1, 2017

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks for JOSS. @pjotrp it looks like you're currently assigned as the editor for this paper 🎉

For a list of things I can do to help you, just type:

@whedon commands

@arfon
Copy link
Member

arfon commented Oct 1, 2017

👋 @pjotrp - the submitting author suggested you as the editor.

@vsoch
Copy link

vsoch commented Oct 1, 2017

Hi @whedon, @arfon, and @pjotrp - many thanks for the introduction, and looking forward to working on this together.

@pjotrp
Copy link

pjotrp commented Oct 2, 2017

@whedon assign @pjotrp as editor

1 similar comment
@pjotrp
Copy link

pjotrp commented Oct 2, 2017

@whedon assign @pjotrp as editor

@whedon whedon assigned pjotrp and unassigned pjotrp Oct 2, 2017
@whedon
Copy link
Author

whedon commented Oct 2, 2017

OK, the editor is @pjotrp

@pjotrp
Copy link

pjotrp commented Oct 6, 2017

Dear @smoe would you care to review this Singularity submission?

@smoe
Copy link

smoe commented Oct 6, 2017

Dear @pjotrp,

Singularity is important and everything that fosters its acceptance is appreciated.

The setup is technically sound. I like the distributed effort. What seems missing is the concept of mirroring images for long time availability when a site goes down, which then truly preserves setups for scientific reproducibility. For that to happen, we would need identifiers that are not URL-dependent, though. Another feature I am missing is the automated creation of images, which would nicely work together with the description of CWL workflows that features references to software registries which in turn started to have references to Linux distributions (OMICtools now, bio.tools soon, I hope) and Debian at least having references to the registries already.

Not having an exact clue what you ask me to review now, I went through your JOSS author guidelines on http://joss.theoj.org/about#author_guidelines:

  • License: BSD 3 clause - ok
  • paper.md is short, a bit too short IMHO, but present. Missing for my heart is a clarification how functionality and contributors differ from http://singularity.lbl.gov/, singularity-hub.org and github. Sorry, this is mostly trivial, but I strongly suggest to make these few lines as simple as possible. Frankly, I do not even expect everyone to know what a container is. Should users of docker also consider singularityhub instead of hub.docker.io? Are there features of singularity that are particularly supported by singularityhub?
  • authors found
  • The "summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience" as I already outlined above is marginal.
  • The "clear statement of need that illustrates the purpose of the software" we have - not that any fan of singularity would need it.
  • The "list of key references including a link to the software archive" is weak. Once the paper gets extended with the prior requested bit of extra content for those who are not using singularity already, this will become better. Maybe the authors' guide is a bit vague here. There is the citation system http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html that should be used.
  • Does it "Mention (if applicable) of any ongoing research projects using the software or recent scholarly publications enabled by it"? No, it doesn't. I described in my initial lines who is waiting for it, though that is possibly too immature to be put into this paper.md. But you can of course outline that you foresee these kind of interactions between your service and others.

The other "requirements for submission" I find kind of redundant and I consider them to be fulfilled.

What I would typically do now is to install this locally and see if this works, which I kind of hope not to be imposed on me because the authors declare to us that they are working with exactly that setup themselves and that what we see is live on https://singularity-hub.org/collections or elsewhere - this is what should be explicitly stated in the paper.md, too.

Otherwise, I hope this was not too obvious, I am a fan.

@pjotrp
Copy link

pjotrp commented Oct 6, 2017

Thanks Steffen - we'll have to move to official review so you can tick the boxes. I'll copy your text in.

@pjotrp
Copy link

pjotrp commented Oct 6, 2017

@whedon assign @smoe as reviewer

@whedon whedon assigned pjotrp and unassigned pjotrp Oct 6, 2017
@whedon
Copy link
Author

whedon commented Oct 6, 2017

OK, the reviewer is @smoe

@pjotrp
Copy link

pjotrp commented Oct 6, 2017

@whedon start review magic-word=bananas

@whedon
Copy link
Author

whedon commented Oct 6, 2017

OK, I've started the review over in #426. Feel free to close this issue now!

@pjotrp pjotrp closed this as completed Oct 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants