-
-
Notifications
You must be signed in to change notification settings - Fork 41
[REVIEW]: Disimpy: A massively parallel Monte Carlo simulator for synthesizing diffusion-weighted MRI data in Python #2527
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
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @DARSakthi, @grlee77, @ritagnunes it looks like you're currently assigned to review this paper 🎉. 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:
For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
@whedon generate pdf |
@whedon check references |
|
@DARSakthi, @grlee77, @ritagnunes this is just a friendly check in. I know some of you are busy on other reviews too. Could you give an update on when you expect to work on this review? |
@Kevin-Mattheus-Moerman, most likely I will only be able to work on this
after the end of the ISMRM conference, i.e. the week after next...
…On Wed, Aug 5, 2020 at 11:40 AM Kevin Mattheus Moerman < ***@***.***> wrote:
@DARSakthi <https://github.com/DARSakthi>, @grlee77
<https://github.com/grlee77>, @ritagnunes <https://github.com/ritagnunes>
this is just a friendly check in. I know some of you are busy on other
reviews too. Could you give an update on when you expect to work on this
review?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#2527 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AIZGNBGCARKW6VYWK5J6X2TR7EZIRANCNFSM4PKLFXQQ>
.
|
Right, sorry I forgot about the ISMRM. Enjoy the conference! |
@kerkelae, can you briefly describe the contributions of the coauthors you included? I could only verify your name directly in the commit history, but understand that there are other ways to contribute. |
@Kevin-Mattheus-Moerman Thanks for the reminder -- some other deadlines had dragged my attention away -- will have it done by Monday, latest. Cheers |
regarding the following review criteria:
Is the script that produced Fig. 1 available anywhere? I find the result believable, but did not try to install Camino to verify. I can confirm that all of the examples in the Jupyter notebook in the repository ran quickly on an NVIDIA GTX-1080 Ti card. update: I just added some timing statements to examples for the mesh in the Jupyter notebook examples and the result is consistent with the Disimpy curve in the figure. |
Overall the manuscript and software look good to me and I have only some minor suggestions. minor points to address 1.) In the NumPy reference, the first author should be "van der Walt, S." rather than "Walt, S. van der" 2.) In the second sentence under features, I recommend the following grammatical change: 3.) In the documentation's installation instructions a one-step command that might be easier for users than downloading the repository and then navigating to the folder to run pip would be to use: 4.) It may be worth providing a version of the demo notebook on Google Colaboratory as well, so users can try it out without having to own a CUDA-compatible GPU. 5.) Can the authors confirm if Camino's CPU-based Monte-Carlo is multi-threaded? If so, I would mention that explicitly in the manuscript text or Fig. 1 caption as it makes the relative improvement on the GPU more impressive. 6.) Regarding the "state of the filed" review criteria, I don't see much in the manuscript corresponding to this aside from the comparison to Camino. This is not an area I am particular familiar with the literature, so it would be good to know:
7.) The included references look good, but I would include also reference previous work doing similar types of simulations on the GPU. For example:
(optional)
misc comments Validation of accuracy of the simulations was not discussed in the manuscript, but from what I can tell, the authors have done validation via the following: |
Hi @grlee77, thanks for the feedback. Just a quick comment in terms of direct commits to the repo itself I didn't make a lot of them and they are no longer visible because we cleaned up the commit history for submission (made an orphan branch). They are still visible as closed PRs. In any case I will let @kerkelae describe the authors' contributions. |
Good point @grlee77. I am the main author and have written most of the code and of the manuscript. Fabio Nery has helped by implementing various algorithms, making decisions on how to package the code, and testing. Matt Hall and Chris Clark have contributed to the software by being very involved in the planning and development phase of much of the code that the final package consists of. Thank you for the feedback. We will address the other issues you raised very soon. |
Overall the paper is well done. The tutorial section of the documentation is a nice touch, and the mathematical specification in the final section of the paper is also appreciated. Having a colab notebook would be an excellent idea. I echo the suggestions of @grlee77, in particular verification of the performance claims. I do question the use of the word synthesising in the title -- while 'to synthesise' can mean to produce artificially, a more common usage is to combine. If the authors are partial to the title then no change is necessary, but a better word may clarify the function of the software. |
@grlee77 and @DARSakthi, thank you for the feedback. We have made a number of changes to the manuscript and the documentation. Please see the points below.
|
@whedon generate pdf |
Is the test script you linked to available in the repo too? I can't seem to find it. If not, I think it could be a good thing to include from an end - user stand point, so as to evaluate whether to use the software or not. With the most recent round of changes, I am happy to recommend the paper for publication. Well done! |
I really enjoyed being able to run the Tutorial on Google Colaboratory. That was a really nice addition! Also, the provided examples make it easy to verify the requirement of simulating a high number of random walkers to match the theoretical predictions motivating the need for this software. I also like it that the authors have included a range of microstructural environments, from free to restricted diffusion including multiple compartments and a diffraction example replicating a previous study. It was harder for me to evaluate the gains in simulation speed as the software and corresponding tutorial do not run without GPU-enabled acceleration. Although I did not run Camino independently, I trust that the simulation times reported in the tests are correct. The provided documentation is quite comprehensive and the paper clearly motivates the need for the software, describing the implemented features. I also really like that the basic theoretical equations have been included. I agree with @DARSakthi and I am also happy to recommend the publication of this paper. |
The version on the JOSS site will update when the paper is published. |
@whedon generate pdf |
@whedon check references |
|
@kerkelae I've checked your paper and can confirm it looks in order. These are final steps to complete:
|
@Kevin-Mattheus-Moerman, thank you. Since we changed a few things during the review, I created a new release: |
@kerkelae thanks. However you still need to amend the title and authors of that archive to match the paper title. Let me know when you've completed that. |
@whedon set 10.5281/zenodo.4001687 as archive |
OK. 10.5281/zenodo.4001687 is the archive. |
@whedon set v0.1.1 as version |
OK. v0.1.1 is the version. |
@Kevin-Mattheus-Moerman It's fixed now. |
@whedon accept |
|
|
👋 @openjournals/joss-eics, this paper is ready to be accepted and published. Check final proof 👉 openjournals/joss-papers#1673 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1673, then you can now move forward with accepting the submission by compiling again with the flag
|
@whedon accept deposit=true |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
Submitting author: @kerkelae (Leevi Kerkelä)
Repository: https://github.com/kerkelae/disimpy
Version: v0.1.1
Editor: @Kevin-Mattheus-Moerman
Reviewer: @DARSakthi, @grlee77, @ritagnunes
Archive: 10.5281/zenodo.4001687
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 badge code:
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
@DARSakthi & @grlee77 & @ritagnunes, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
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 @DARSakthi
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @grlee77
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @ritagnunes
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
The text was updated successfully, but these errors were encountered: