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]: MSMExplorer: Data Visualizations for Biomolecular Dynamics #188

Closed
17 tasks done
whedon opened this issue Feb 27, 2017 · 14 comments
Closed
17 tasks done

[REVIEW]: MSMExplorer: Data Visualizations for Biomolecular Dynamics #188

whedon opened this issue Feb 27, 2017 · 14 comments
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Feb 27, 2017

Submitting author: @cxhernandez (Carlos Xavier Hernández)
Repository: https://github.com/msmexplorer/msmexplorer
Version: v1.0.0
Editor: @arokem
Reviewer: @anotherjoshsmith
Archive: 10.5281/zenodo.439774

Status

status

Status badge code:

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

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 questions

Conflict of interest

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (such as being a major contributor to the software).

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 (v1.0.0)?
  • Authorship: Has the submitting author (@cxhernandez) made major contributions to the software?

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: Have any performance claims of the software been confirmed?

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
Copy link
Author

whedon commented Feb 27, 2017

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks for JOSS. @anotherjoshsmith 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 as reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all JOSS 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

@arokem
Copy link

arokem commented Mar 2, 2017

@arfon : why does this say "Does the release version given match the GitHub release (v1.0.0)?"?

The current release version on Github is 0.3. Where does the 1.0.0 come from?

@cxhernandez
Copy link

@arokem: That's my fault. My intention was to hold off on making a v1.0.0 release until the review is done. In my previous experience with JOSS, the reviewer at the time requested additional functionality to package, and it required us to cut a new release anyways.

@arokem
Copy link

arokem commented Mar 2, 2017

Gotcha - thanks! That means that @anotherjoshsmith should go through everything else, wait until everything else is in order, and then wait for you to cut a v1.0.0 before checking that box. Is that your intention?

@cxhernandez
Copy link

Yeah, that would be great!

@anotherjoshsmith
Copy link

@cxhernandez I've submitted a short task list for JOSS acceptance as an issue. Please let me know if you have any questions or comments on these. I think you have put together a very useful research tool. I've even started testing it with data sets of my own!

@cxhernandez
Copy link

I think you have put together a very useful research tool. I've even started testing it with data sets of my own!

That's great to hear! Thanks!

I've made a PR that addresses each task item. Let me know what you think!

@anotherjoshsmith
Copy link

All review issues have been resolved.

@arokem: I suggest "MSMExplorer: Data Visualizations for Biomolecular Dynamics" by @cxhernandez et al. be accepted by JOSS.

@arokem
Copy link

arokem commented Apr 7, 2017

Thank you @anotherjoshsmith!

@cxhernandez : could you please create a Zenodo archive with the 1.0.0 version? Once you do that, I can set that as the archive, and move ahead to accept and close this issue.

@cxhernandez
Copy link

@arokem: The archive for v1.0.0 can be found here.

@arokem
Copy link

arokem commented Apr 8, 2017

@whedon set 10.5281/zenodo.439774 as archive

@whedon
Copy link
Author

whedon commented Apr 8, 2017

OK. 10.5281/zenodo.439774 is the archive.

@arokem
Copy link

arokem commented Apr 8, 2017

@arfon : I believe this one is ready to go! Anything else I need to do to get this one into this page: http://joss.theoj.org/papers/popular?

@arfon arfon added the accepted label Apr 8, 2017
@arfon
Copy link
Member

arfon commented Apr 8, 2017

@arfon : I believe this one is ready to go! Anything else I need to do to get this one into this page: http://joss.theoj.org/papers/popular?

@arokem - I still have to do the last few bits. Planning on giving @whedon those super-powers sometime soon.

@arokem many thanks for editing this and @anotherjoshsmith for your review ✨

@cxhernandez - your paper is now accepted into JOSS and your DOI is http://dx.doi.org/10.21105/joss.00188 ⚡ 🚀 💥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

5 participants