Skip to content

[REVIEW]: fastPLI: A Fiber Architecture Simulation Toolbox for 3D-PLI #3042

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
60 tasks done
whedon opened this issue Feb 15, 2021 · 62 comments
Closed
60 tasks done

[REVIEW]: fastPLI: A Fiber Architecture Simulation Toolbox for 3D-PLI #3042

whedon opened this issue Feb 15, 2021 · 62 comments
Assignees
Labels
accepted CMake Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Shell

Comments

@whedon
Copy link

whedon commented Feb 15, 2021

Submitting author: @fmatuschke (Felix Matuschke)
Repository: https://github.com/3d-pli/fastpli
Version: 1.1.0
Editor: @oliviaguest
Reviewers: @vigji, @glyg, @RealPolitiX
Archive: 10.5281/zenodo.4720075

⚠️ 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/0c61ea3e028958db084f788747481dab"><img src="https://joss.theoj.org/papers/0c61ea3e028958db084f788747481dab/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/0c61ea3e028958db084f788747481dab/status.svg)](https://joss.theoj.org/papers/0c61ea3e028958db084f788747481dab)

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

@vigji, 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 @oliviaguest 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 @glyg

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 (@fmatuschke) 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: Does the paper have a section titled 'Statement of Need' that clearly states 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 @vigji

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 (@fmatuschke) 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: Does the paper have a section titled 'Statement of Need' that clearly states 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 @RealPolitiX

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 (@fmatuschke) 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: Does the paper have a section titled 'Statement of Need' that clearly states 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 Feb 15, 2021

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

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

OK DOIs

- 10.3389/fninf.2011.00034 is OK
- 10.3233/APC190017 is OK
- 10.1103/physrevx.10.021002 is OK
- 10.17815/jlsrf-2-121 is OK
- 10.3389/fnana.2018.00075 is OK
- 10.1016/j.neuroimage.2015.02.020 is OK
- 10.1098/rsif.2015.0734 is OK
- 10.1145/2833157.2833162 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Feb 15, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.34 s (347.2 files/s, 110372.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
SVG                              4              2              2          21804
Python                          49           1601           1480           4518
C++                             15            692            202           2978
C/C++ Header                    19            304             69           1451
Markdown                         4            115              0            275
CMake                            5             39             36            201
YAML                             3             16             21            180
Jupyter Notebook                 2              0            418            176
Bourne Shell                    10             30             14            165
make                             2             34             10            145
TeX                              1              8              0            100
reStructuredText                 3             17             80              9
-------------------------------------------------------------------------------
SUM:                           117           2858           2332          32002
-------------------------------------------------------------------------------


Statistical information for the repository '845d1dee56dd4b12c318a43e' was
gathered on 2021/02/15.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
fmatuschke                     658         30396          17112          100.00

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
fmatuschke                13295           43.7         11.1                6.30

@whedon whedon added the Shell label Feb 15, 2021
@whedon
Copy link
Author

whedon commented Feb 15, 2021

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

@oliviaguest
Copy link
Member

Thank you so much, @vigji for accepting to review this. I want to find at least one more reviewer, but since you started reviewing already, please feel free to indeed get started.

Please read the instructions above. If you have trouble ticking things off in the list above, remember you need to click to "accept" here: https://github.com/openjournals/joss-reviews/invitations! Any questions, feedback on the paper, etc., please post here. Any very code-specific questions, suggestions, etc., please use the issues in the code repo and link to them from this thread, so we can all keep track of them. 🌸

For examples of how this process plays out feel free to skim previous reviews, such as: #2285 and #2348. ☺️

@oliviaguest
Copy link
Member

@whedon add @glyg as reviewer

@whedon whedon assigned oliviaguest and vigji and unassigned oliviaguest and vigji Feb 16, 2021
@whedon
Copy link
Author

whedon commented Feb 16, 2021

OK, @glyg is now a reviewer

@openjournals openjournals deleted a comment from whedon Feb 16, 2021
@oliviaguest
Copy link
Member

👋 @glyg welcome! Make sure to read the instructions above, accept the invitation, etc.

@vigji
Copy link

vigji commented Feb 16, 2021

I'll link here below all issues related to this review:

3d-pli/fastpli#1

3d-pli/fastpli#2

3d-pli/fastpli#3

3d-pli/fastpli#4

3d-pli/fastpli#5

3d-pli/fastpli#6

@oliviaguest
Copy link
Member

@whedon add @RealPolitiX as reviewer

@whedon whedon assigned glyg, oliviaguest and vigji and unassigned glyg, oliviaguest and vigji Feb 18, 2021
@whedon
Copy link
Author

whedon commented Apr 26, 2021

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

OK DOIs

- 10.3389/fninf.2011.00034 is OK
- 10.3233/APC190017 is OK
- 10.1103/physrevx.10.021002 is OK
- 10.17815/jlsrf-4-121-1 is OK
- 10.3389/fnana.2018.00075 is OK
- 10.1016/j.neuroimage.2015.02.020 is OK
- 10.1098/rsif.2015.0734 is OK
- 10.1145/2833157.2833162 is OK
- 10.1103/physreve.83.041804 is OK
- 10.3389/fninf.2017.00005 is OK
- 10.1016/j.neuroimage.2019.02.055 is OK
- 10.1364/opex.13.004420 is OK
- 10.1117/1.3241986 is OK
- 10.1016/j.optcom.2020.126113 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@oliviaguest
Copy link
Member

@whedon generate pdf

@oliviaguest
Copy link
Member

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 26, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Apr 26, 2021
@whedon
Copy link
Author

whedon commented Apr 26, 2021

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

OK DOIs

- 10.3389/fninf.2011.00034 is OK
- 10.3233/APC190017 is OK
- 10.1103/physrevx.10.021002 is OK
- 10.17815/jlsrf-4-121-1 is OK
- 10.3389/fnana.2018.00075 is OK
- 10.1016/j.neuroimage.2015.02.020 is OK
- 10.1098/rsif.2015.0734 is OK
- 10.1145/2833157.2833162 is OK
- 10.1103/physreve.83.041804 is OK
- 10.3389/fninf.2017.00005 is OK
- 10.1016/j.neuroimage.2019.02.055 is OK
- 10.1364/opex.13.004420 is OK
- 10.1117/1.3241986 is OK
- 10.1016/j.optcom.2020.126113 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 26, 2021

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

@whedon
Copy link
Author

whedon commented Apr 26, 2021

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

Check final proof 👉 openjournals/joss-papers#2262

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

@whedon accept deposit=true

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Apr 30, 2021

@fmatuschke I have proofread your paper and have some very minor comments which I hope you can address:

  • Please check It allows contrasting fibers and fiber tracts and ultimately reconstructing 3D nerve fiber orientations, some words seem missing. Should this be something like It provides image contrast for fibers and fiber tracts, and ultimately enables reconstruction of 3D nerve fiber orientations?
  • Please introduce the acronym dMRI for diffusion magnetic resonance imaging, when the terms are first used/introduced.
  • Consider changing Different types of simulation... to Different types of simulations...

Once you have considered the above please call @whedon generate pdf to update the paper. I will then review the changes and process acceptance when ready.

One more important note relates to the Zenodo archive

  • Please ensure that the meta-data for the Zenodo archive matches that of the paper in terms of the author list as well as the title. Currently the archive title read: Fiber Architecture Simulation Toolbox for 3D-PLI but this should match the paper and be changed to fastPLI: A Fiber Architecture Simulation Toolbox for3D-PLI. You can manually change this on Zenodo.

The version tag for the Zenodo archive is 1.1.0. I will therefore assume we should update the version tag here also. I will do this shortly below 👇.

Thanks.

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon set 1.1.0 as version

@whedon
Copy link
Author

whedon commented Apr 30, 2021

OK. 1.1.0 is the version.

@fmatuschke
Copy link

Dear @Kevin-Mattheus-Moerman,
I change all three of your comments. Thanks for your help.
Regarding the version number. Yes, it is now officially 1.1. Thanks to the reviewers I changed quite a bit, so I had to increase the minor version.
I have also corrected the title in the Zenodo archive.

@fmatuschke
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented May 3, 2021

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

@openjournals openjournals deleted a comment from whedon May 3, 2021
@openjournals openjournals deleted a comment from whedon May 3, 2021
@Kevin-Mattheus-Moerman
Copy link
Member

@whedon accept

@whedon
Copy link
Author

whedon commented May 3, 2021

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented May 3, 2021

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

OK DOIs

- 10.3389/fninf.2011.00034 is OK
- 10.3233/APC190017 is OK
- 10.1103/physrevx.10.021002 is OK
- 10.17815/jlsrf-4-121-1 is OK
- 10.3389/fnana.2018.00075 is OK
- 10.1016/j.neuroimage.2015.02.020 is OK
- 10.1098/rsif.2015.0734 is OK
- 10.1145/2833157.2833162 is OK
- 10.1103/physreve.83.041804 is OK
- 10.3389/fninf.2017.00005 is OK
- 10.1016/j.neuroimage.2019.02.055 is OK
- 10.1364/opex.13.004420 is OK
- 10.1117/1.3241986 is OK
- 10.1016/j.optcom.2020.126113 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented May 3, 2021

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

Check final proof 👉 openjournals/joss-papers#2274

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

@whedon accept deposit=true

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon accept deposit=true

@whedon whedon added accepted published Papers published in JOSS labels May 3, 2021
@whedon
Copy link
Author

whedon commented May 3, 2021

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

@whedon
Copy link
Author

whedon commented May 3, 2021

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

@whedon
Copy link
Author

whedon commented May 3, 2021

🚨🚨🚨 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.03042 joss-papers#2275
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03042
  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 @fmatuschke this work is now published in JOSS.
Thank you @oliviaguest for editing this submission!

Thanks also to @vigji, @glyg, @RealPolitiX for your help reviewing this work!!!

@whedon
Copy link
Author

whedon commented May 3, 2021

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

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

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

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 CMake Makefile 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