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]: PyQMRI: An accelerated Python based Quantitative MRI Python toolbox #2727

Closed
60 tasks done
whedon opened this issue Oct 7, 2020 · 90 comments
Closed
60 tasks done
Assignees
Labels
accepted C published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Shell

Comments

@whedon
Copy link

whedon commented Oct 7, 2020

Submitting author: @MaierOli2010 (Oliver Maier)
Repository: https://github.com/IMTtugraz/PyQMRI
Version: v1.0.0
Editor: @Kevin-Mattheus-Moerman
Reviewer: @grlee77, @agahkarakuzu, @DARSakthi
Archive: 10.5281/zenodo.4313301

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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

@grlee77 & @agahkarakuzu & @DARSakthi, 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 @Kevin-Mattheus-Moerman know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Review checklist for @grlee77

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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?
  • Contribution and authorship: Has the submitting author (@MaierOli2010) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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

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

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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?
  • Contribution and authorship: Has the submitting author (@MaierOli2010) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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

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

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

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?
  • Contribution and authorship: Has the submitting author (@MaierOli2010) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

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

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

whedon commented Oct 7, 2020

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @grlee77, @ @agahkarakuzu, @DARSakthi it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

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

whedon commented Oct 7, 2020

PDF failed to compile for issue #2727 with the following error:

/app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in block in find': No such file or directory - e1e19e2b7e83c454b0cb0797 (Errno::ENOENT) from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in collect!'
from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in find' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/lib/whedon/processor.rb:66:in find_paper_paths'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/bin/whedon:53:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/bin/whedon:131:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf from branch joss-paper

@whedon
Copy link
Author

whedon commented Oct 7, 2020

Attempting PDF compilation from custom branch joss-paper. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 7, 2020

PDF failed to compile for issue #2727 with the following error:

sh: 1: cd: can't cd to 09e65fba2022502e74700760
/app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in block in find': No such file or directory - 09e65fba2022502e74700760 (Errno::ENOENT) from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in collect!'
from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in find' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/lib/whedon/processor.rb:66:in find_paper_paths'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/bin/whedon:53:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-d14a699185fb/bin/whedon:131:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf from branch JOSS_pub

@whedon
Copy link
Author

whedon commented Oct 7, 2020

Attempting PDF compilation from custom branch JOSS_pub. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 7, 2020

PDF failed to compile for issue #2727 with the following error:

pandoc-citeproc: reference agahkarakuzu not found
Error producing PDF.
! TeX capacity exceeded, sorry [input stack size=5000].
\reserved@a ->\def \reserved@a
*{\let @xs@assign @xs@expand@and@detokenize...
l.336 }

Looks like we failed to compile the PDF

@Kevin-Mattheus-Moerman
Copy link
Member

@MaierOli2010 can you check ☝️ that reference?

@MaierOli2010
Copy link

MaierOli2010 commented Oct 7, 2020

@Kevin-Mattheus-Moerman agahkarakuzu should be the git name of one of the reviewers. I do not have any reference that could conatin that name though (just checked the paper.bib file).

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev @arfon have a look at this issue ☝️, it looks like when I assigned agahkarakuzu as reviewer over at #2718 they got a double @ in their assigned name, see also at the top of this issue. Looks like that might be causing this.
How will I fix this? Will I remove @ @agahkarakuzu, and add @agahkarakuzu as reviewer again?

@arfon
Copy link
Member

arfon commented Oct 7, 2020

@whedon generate pdf from branch JOSS_pub

@whedon
Copy link
Author

whedon commented Oct 7, 2020

Attempting PDF compilation from custom branch JOSS_pub. Reticulating splines etc...

@arfon
Copy link
Member

arfon commented Oct 7, 2020

@Kevin-Mattheus-Moerman - I just edited the issue manually.

@whedon
Copy link
Author

whedon commented Oct 7, 2020

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@agahkarakuzu
Copy link

@Kevin-Mattheus-Moerman I came back to this issue to see the latest changes, then noticed that I still don't appear on the list of reviewers.

@Kevin-Mattheus-Moerman
Copy link
Member

@agahkarakuzu I think this looks good now right? Can you confirm you are able to tick boxes?

@Kevin-Mattheus-Moerman
Copy link
Member

@grlee77, @agahkarakuzu, @DARSakthi thanks for your review efforts!!!

If see some of you have left some boxes unticked. If you could summarize for the authors what work is needed that would be great.

Thanks.

@agahkarakuzu
Copy link

@Kevin-Mattheus-Moerman I cannot check the boxes :/

@arfon
Copy link
Member

arfon commented Nov 2, 2020

@whedon re-invite @agahkarakuzu as reviewer

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf from branch JOSS_pub

@whedon
Copy link
Author

whedon commented Dec 11, 2020

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

1 similar comment
@whedon
Copy link
Author

whedon commented Dec 11, 2020

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Dec 11, 2020

@MaierOli2010 I have two minor points about the paper:

  • For consistency, can you add "Austria" to the 3rd affiliation?

  • Should the heading "Algorithmic" be "Algorithms" instead?

@MaierOli2010
Copy link

@Kevin-Mattheus-Moerman
Added "Austria" to the 3rd affiliation and renamed "Algorithmic" to "Algorithms"
Both changes are done to "master" branch as I've merged everything there.

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Dec 12, 2020

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon accept

@whedon
Copy link
Author

whedon commented Dec 12, 2020

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Dec 12, 2020
@whedon
Copy link
Author

whedon commented Dec 12, 2020

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#1978

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

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Dec 12, 2020

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1137/090769521 is OK
- 10.1002/mrm.27502 is OK
- 10.1007/s10851-010-0251-1 is OK
- 10.1016/j.parco.2011.09.001 is OK
- 10.1016/0167-2789(92)90242-F is OK
- 10.1109/TMI.2016.2564989 is OK
- 10.1002/mrm.22595 is OK
- 10.1109/TMI.2009.2023119 is OK
- 10.1109/TIT.2006.871582 is OK
- 10.1002/mrm.21391 is OK
- 10.1002/mrm.22483 is OK
- 10.1007/978-3-642-54774-4_3 is OK
- 10.24355/dbbs.084-201305311128-0 is OK
- 10.1002/ima.22196 is OK
- 10.1137/16M1092015 is OK
- 10.1007/s10589-012-9476-9 is OK
- 10.1002/mrm.20283 is OK
- 10.1016/j.neuroimage.2019.01.029 is OK
- 10.21105/joss.00656 is OK
- 10.21105/joss.02343 is OK
- 10.3389/fninf.2014.00008 is OK
- 10.1038/nm.3390 is OK
- 10.1016/B978-012372560-8/50002-4 is OK
- 10.1186/s12968-019-0570-3 is OK
- 10.1002/mrm.26726 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon accept deposit=true

@whedon whedon added accepted published Papers published in JOSS labels Dec 12, 2020
@whedon
Copy link
Author

whedon commented Dec 12, 2020

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

@whedon
Copy link
Author

whedon commented Dec 12, 2020

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

@whedon
Copy link
Author

whedon commented Dec 12, 2020

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.02727 joss-papers#1979
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.02727
  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...

@Kevin-Mattheus-Moerman
Copy link
Member

Congratulations @MaierOli2010!

Thanks for another excellent review @grlee77, @agahkarakuzu, @DARSakthi!!!

@whedon
Copy link
Author

whedon commented Dec 12, 2020

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

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

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

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:

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

No branches or pull requests

7 participants