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]: Open-Unmix - A Reference Implementation for Music Source Separation #1667

Closed
whedon opened this issue Aug 21, 2019 · 56 comments

Comments

@whedon
Copy link
Collaborator

commented Aug 21, 2019

Submitting author: @faroit (Fabian-Robert Stöter)
Repository: https://github.com/sigsep/open-unmix-paper-joss
Version: v1.0.0
Editor: @arokem
Reviewer: @bmcfee, @hagenw
Archive: 10.5281/zenodo.3402103

Status

status

Status badge code:

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

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

@bmcfee & @hagenw, 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 @arokem know.

Please try and complete your review in the next two weeks

Review checklist for @bmcfee

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 (v1.0.0)?
  • Authorship: Has the submitting author (@faroit) 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)?

Review checklist for @hagenw

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 (v1.0.0)?
  • Authorship: Has the submitting author (@faroit) 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 Aug 21, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @bmcfee, @hagenw it looks like you're currently assigned to review 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

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 21, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 21, 2019

@bmcfee

This comment has been minimized.

Copy link

commented Aug 21, 2019

@arokem just checking over the COI policy -- the main author has contributed to some software projects that i maintain (and have published on). It's not totally obvious to me whether that constitutes a COI. I don't think this would impede my ability to review, but full disclosure and all.

@arokem

This comment has been minimized.

Copy link

commented Aug 21, 2019

Just to clarify: has the main author been a co-author on any of the papers that you have published on your software?

@bmcfee

This comment has been minimized.

Copy link

commented Aug 21, 2019

has the main author been a co-author on any of the papers that you have published on your software?

Nope.

@arokem

This comment has been minimized.

Copy link

commented Aug 22, 2019

In my reading, this does not constitute COI. If you feel at all uncomfortable, I'd be happy to look for another reviewer. Otherwise, I think that your statement that this association will not impede your ability to review the article is sufficient for you to check that box and move ahead.

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

Cool, we're in agreement then. Thanks!

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

sigsep/open-unmix-paper-joss#2 - on version numbers

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

sigsep/open-unmix-paper-joss#3 - on including source code and a related issue with the docs

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

sigsep/open-unmix-paper-joss#4 - on performance

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

sigsep/open-unmix-paper-joss#5 - on documentation/API

@bmcfee

This comment has been minimized.

Copy link

commented Aug 22, 2019

sigsep/open-unmix-paper-joss#6 - on community guidelines

@hagenw

This comment has been minimized.

Copy link

commented Aug 30, 2019

@faroit

This comment has been minimized.

Copy link

commented Aug 30, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 30, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 30, 2019

@faroit

This comment has been minimized.

Copy link

commented Aug 31, 2019

we would like to officially release the software next week. It would be great if we could provide a DOI soon so that researchers can use this as a baseline e.g. for the upcoming ICASSP.

@hagenw @bmcfee thank you again for your time and help. It would be great to know for us if could tell us when you find time to complete the review so we know if we might want to prepare a preprint.

@hagenw

This comment has been minimized.

Copy link

commented Sep 1, 2019

I think that should be possible. I'm done with the review of all the written parts and will install and test the software on Monday or Tuesday. If everything works fine then the review should be finished in time.

@hagenw

This comment has been minimized.

Copy link

commented Sep 1, 2019

@hagenw

This comment has been minimized.

Copy link

commented Sep 1, 2019

@bmcfee

This comment has been minimized.

Copy link

commented Sep 1, 2019

Everything looks good on my end, checkboxes completed.

@hagenw

This comment has been minimized.

Copy link

commented Sep 2, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 2, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 2, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 3, 2019


OK DOIs

- 10.1109/ICASSP.2011.5946809 is OK
- 10.5281/zenodo.3269749 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.5281/zenodo.3338373 is OK
- 10.5281/zenodo.3382104 is OK
- 10.5281/zenodo.3370486 is OK
- 10.5281/zenodo.3370489 is OK
- 10.5281/zenodo.3261102 is OK
- 10.5281/zenodo.3271451 is OK
- 10.1109/ICASSP.2019.8683251 is OK
- 10.1109/ICASSP.2019.8683555 is OK
- 10.1109/TASL.2011.2172425 is OK
- 10.1007/978-3-319-53547-0_25 is OK
- 10.1016/j.sigpro.2011.10.007 is OK
- 10.1007/978-3-642-28551-6_51 is OK
- 10.1109/MLSP.2013.6661988 is OK
- 10.1007/978-3-319-22482-4_45 is OK
- 10.1007/978-3-319-53547-0_31 is OK
- 10.1007/978-3-319-93764-9_28 is OK
- 10.5281/zenodo.1117372 is OK
- 10.1109/MSP.2018.2874719 is OK
- 10.1109/ICASSP.2017.7952158 is OK
- 10.1109/ICASSP.2015.7178348 is OK
- 10.1109/TASLP.2016.2580946 is OK
- 10.1109/ASRU.2015.7404834 is OK
- 10.1109/JSTSP.2019.2904183 is OK
- 10.21437/Interspeech.2018-1773 is OK
- 10.1109/MSP.2018.2875349 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@faroit

This comment has been minimized.

Copy link

commented Sep 4, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 4, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 4, 2019

@faroit

This comment has been minimized.

Copy link

commented Sep 6, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 6, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 6, 2019

@faroit

This comment has been minimized.

Copy link

commented Sep 6, 2019

@arokem I did some last little update on the bibliography and I think we are good here. Please tell me what the next steps are to proceed.

@arokem

This comment has been minimized.

Copy link

commented Sep 7, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 7, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 7, 2019


OK DOIs

- 10.1109/ICASSP.2011.5946809 is OK
- 10.5281/zenodo.3386463 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.5281/zenodo.3338373 is OK
- 10.5281/zenodo.3382104 is OK
- 10.5281/zenodo.3370486 is OK
- 10.5281/zenodo.3370489 is OK
- 10.5281/zenodo.3261102 is OK
- 10.5281/zenodo.3271451 is OK
- 10.1109/ICASSP.2019.8683251 is OK
- 10.1109/ICASSP.2019.8683555 is OK
- 10.1109/TASL.2011.2172425 is OK
- 10.1007/978-3-319-53547-0_25 is OK
- 10.1016/j.sigpro.2011.10.007 is OK
- 10.1007/978-3-642-28551-6_51 is OK
- 10.1109/MLSP.2013.6661988 is OK
- 10.1007/978-3-319-22482-4_45 is OK
- 10.1007/978-3-319-53547-0_31 is OK
- 10.1007/978-3-319-93764-9_28 is OK
- 10.5281/zenodo.1117372 is OK
- 10.1109/MSP.2018.2874719 is OK
- 10.1109/ICASSP.2017.7952158 is OK
- 10.1109/ICASSP.2015.7178348 is OK
- 10.1109/TASLP.2016.2580946 is OK
- 10.1109/ASRU.2015.7404834 is OK
- 10.1109/JSTSP.2019.2904183 is OK
- 10.21437/Interspeech.2018-1773 is OK
- 10.1109/MSP.2018.2875349 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@arokem

This comment has been minimized.

Copy link

commented Sep 7, 2019

@faroit : At this point, could you please make a new release of the main repo that includes all of the changes that have resulted from the review? Then, please make an archive of the software in Zenodo/figshare/other service and update this thread with the DOI of the archive. For the archive version, please make sure that:

  • The title of the archive is the same as the JOSS paper title
  • The authors of the archive are the same as the JOSS paper authors
@faroit

This comment has been minimized.

Copy link

commented Sep 7, 2019

@arokem all done. Here is the DOI on zenodo: 10.5281/zenodo.3402103

@arokem

This comment has been minimized.

Copy link

commented Sep 8, 2019

@whedon set 10.5281/zenodo.3402103 as archive

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

OK. 10.5281/zenodo.3402103 is the archive.

@arokem

This comment has been minimized.

Copy link

commented Sep 8, 2019

@openjournals/joss-eics : I believe this is ready for your review

@arfon

This comment has been minimized.

Copy link
Member

commented Sep 8, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

Check final proof 👉 openjournals/joss-papers#954

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

@whedon accept deposit=true
@arfon

This comment has been minimized.

Copy link
Member

commented Sep 8, 2019

@whedon accept deposit=true

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

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

@whedon whedon added the accepted label Sep 8, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

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

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

🚨🚨🚨 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 👉 openjournals/joss-papers#955
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01667
  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...

@arfon

This comment has been minimized.

Copy link
Member

commented Sep 8, 2019

@bmcfee, @hagenw - many thanks for your reviews here and to @arokem for editing this submission

@faroit - your paper is now accepted into JOSS ⚡️🚀💥

@arfon arfon closed this Sep 8, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Sep 8, 2019

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

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

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

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:

@bmcfee

This comment has been minimized.

Copy link

commented Sep 8, 2019

Congrats @faroit !

@faroit

This comment has been minimized.

Copy link

commented Sep 11, 2019

@arokem @bmcfee @hagenw Thanks all for your great input. The whole process is very well designed and to be honest, this was the first time I enjoyed submitting a paper. So I am definitely consider to help out and review.

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