Skip to content

[PRE REVIEW]: STReNGTHS, a python package to model and simulate reaction-diffusion systems #6153

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
editorialbot opened this issue Dec 15, 2023 · 40 comments
Assignees
Labels
C++ pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Dec 15, 2023

Submitting author: @ThibaultFillion (Thibault Fillion)
Repository: https://github.com/ThibaultFillion/strengths
Branch with paper.md (empty if default branch): paper
Version: v0.0.8
Editor: @Nikoleta-v3
Reviewers: @parikshitbajpai, @jakryd
Managing EiC: Kevin M. Moerman

Status

status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @ThibaultFillion. Currently, there isn't a JOSS editor assigned to your paper.

@ThibaultFillion if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
@editorialbot editorialbot added pre-review Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials labels Dec 15, 2023
@editorialbot
Copy link
Collaborator Author

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

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

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.11 s (807.8 files/s, 138242.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          35           1889           2207           5036
C/C++ Header                     8            212            216           1155
JSON                             8              0              0           1100
reStructuredText                29            691            765            925
C++                              1             92             36            464
Markdown                         1             33              0            258
TeX                              1             19              0            135
CSS                              1             11              1             56
DOS Batch                        1              8              1             26
YAML                             2              1              4             25
make                             1              4              7              9
JavaScript                       1              1              0              8
TOML                             1              0              0              8
-------------------------------------------------------------------------------
SUM:                            90           2961           3237           9205
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 2346

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1021/j100540a008 is OK
- 10.1103/PhysRevE.71.041103 is OK
- 10.1063/1.1378322 is OK
- 10.1093/bioinformatics/bti431 is OK
- 10.1049/sb:20045021 is OK
- 10.1093/bioinformatics/btw469 is OK
- 10.3389/neuro.11.015.2009 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1109/MCSE.2007.55 is OK

MISSING DOIs

- 10.1371/journal.pcbi.1006830 may be a valid DOI for title: ReaDDy 2: Fast and flexible software framework for interacting-particle reaction dynamics

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

BioSimSpace: An interoperable Python framework for biomolecular simulation
Submitting author: @lohedges
Handling editor: @will-rowe (Retired)
Reviewers: @amritagos, @richardjgowers
Similarity score: 0.8222

MCSD: A MATLAB Tool for Monte-Carlo Simulations of Diffusion in biological Tissues
Submitting author: @davidnsousa
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @nnadeau, @mwacaan
Similarity score: 0.8190

TESPy: Thermal Engineering Systems in Python
Submitting author: @fwitte
Handling editor: @kyleniemeyer (Active)
Reviewers: @arosen93, @corentin-dev
Similarity score: 0.8164

SiSyPHE: A Python package for the Simulation of Systems of interacting mean-field Particles with High Efficiency
Submitting author: @antoinediez
Handling editor: @pdebuyl (Active)
Reviewers: @lorenzo-rovigatti, @junghans
Similarity score: 0.8163

PyStokes: phoresis and Stokesian hydrodynamics in Python
Submitting author: @rajeshrinet
Handling editor: @harpolea (Retired)
Reviewers: @fcooper8472, @khinsen
Similarity score: 0.8144

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@Kevin-Mattheus-Moerman
Copy link
Member

@ThibaultFillion thanks for this submission. While I look for a handling editor please can you work on the following:

  • Please check the above potentially missing/invalid DOIs ☝️ and amend your .bib file where needed. You can call @editorialbot check references to check them again.
  • Please expand your README to include more information as is customary e.g. links to documentation/testing, an installation/ getting started section, contributing guidelines (or a link to them), and a link to the license.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot invite @Nikoleta-v3 as editor

@editorialbot
Copy link
Collaborator Author

Invitation to edit this submission sent!

@Nikoleta-v3
Copy link

@editorialbot assign me as editor

@editorialbot
Copy link
Collaborator Author

Assigned! @Nikoleta-v3 is now the editor

@ThibaultFillion
Copy link

@Kevin-Mattheus-Moerman thank you for having assigned an editor.
@Nikoleta-v3 thank you for accepting to be the editor for this review process.
I take care of the changes you requested as soon as i can.

@ThibaultFillion
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1021/j100540a008 is OK
- 10.1103/PhysRevE.71.041103 is OK
- 10.1063/1.1378322 is OK
- 10.1371/journal.pcbi.1006830 is OK
- 10.1093/bioinformatics/bti431 is OK
- 10.1049/sb:20045021 is OK
- 10.1093/bioinformatics/btw469 is OK
- 10.3389/neuro.11.015.2009 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1109/MCSE.2007.55 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@Nikoleta-v3
Copy link

Great, thank you for fixing the DOI @ThibaultFillion. When you address the comments regarding the README, please ping me here 😄 Also, could you include the commit hash when you do?

@ThibaultFillion
Copy link

ThibaultFillion commented Jan 16, 2024

@Nikoleta-v3 Sorry for the delay. I tried to expand the README file as requested.
The corresponding commit hash is 6a4ae34 (i think).

@Nikoleta-v3
Copy link

Nikoleta-v3 commented Jan 22, 2024

Thank you @ThibaultFillion for your work on the Readme! I just have two questions:

  1. Regarding the contribution guidelines, is there a particular reason why you are referring to this copy of the file instead of this one?

  2. Regarding your test setup, it's great that you have implemented tests. As you point out, one has to run the command

python run_all_tests.py

Are you familiar with the package pytest? I recommend pytest because it works similarly to your run file. It runs all files that have "test" in the name and each function that also has "test" in its name, providing more informative output.

This is what it looks like when I run pytest in the tests folder.

Screenshot 2024-01-22 at 11 55 10 (2)

You can also run pytest tests from the root of the directory.

I'm not saying you should use pytest; it's just a recommendation. If not, could you state something like, "If the command runs and you receive no output, then the tests have passed." after the python run_all_tests.py.

At this point, could you also please check out this page: https://reviewers.joss.theoj.org/lookup and suggest at least three reviewers? 😄

@ThibaultFillion
Copy link

@Nikoleta-v3 Sorry again for the delay. To answer your questions :

  1. I have made a mistake here, linking the github page would be better.
    I will edit the links, thank you for telling me.

  2. Thank you for recommending pytest,
    it would indeed work great with the current implementation.
    For now, i will just go for the second option,
    but i might definitly switch for pytest in the future.
    Thank you again for the advice.

For the reviewers, we recommend :

  • ggmirandac
  • lorenzo-rovigatti
  • ASinanSaglam (not on the list)

@Nikoleta-v3
Copy link

Hello @ThibaultFillion ! I am really sorry for the delay with your submission. The past month has been overwhelming. I am going to start looking for reviewers right away.

@Nikoleta-v3
Copy link

👋🏻 @ggmirandac @ASinanSaglam would any of you be willing to review this submission for JOSS?

We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

The submission I'd like you to review is titled: "STReNGTHS, a python package to model and simulate reaction-diffusion systems". You can find more information at the top of this Github issue 🆙

Please let me know if you're available 😄 Thank you!

@ThibaultFillion
Copy link

@Nikoleta-v3 No problem, thank you for looking for reviewers !

@Nikoleta-v3
Copy link

👋🏻 @Wrzlprmft @parikshitbajpai would any of you be willing to review this submission for JOSS?

We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

The submission I'd like you to review is titled: "STReNGTHS, a python package to model and simulate reaction-diffusion systems". You can find more information at the top of this Github issue 🆙

Please let me know if you're available 😄 Thank you!

@Wrzlprmft
Copy link

👋🏻 @Wrzlprmft […] would any of you be willing to review this submission for JOSS?

Generally yes, but I am very busy until the mid of April, so I won’t be able to even start the review before then.

At a very first glance, the paper seems rather long (for JOSS’s standards) and contains things like installation instructions that do not need to be there.

@parikshitbajpai
Copy link

👋🏻 @Wrzlprmft @parikshitbajpai would any of you be willing to review this submission for JOSS?

We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

The submission I'd like you to review is titled: "STReNGTHS, a python package to model and simulate reaction-diffusion systems". You can find more information at the top of this Github issue 🆙

Please let me know if you're available 😄 Thank you!

Yes, I can review this paper.

@Nikoleta-v3
Copy link

Generally yes, but I am very busy until the mid of April, so I won’t be able to even start the review before then.

At a very first glance, the paper seems rather long (for JOSS’s standards) and contains things like installation instructions that do not need to be there.

@Wrzlprmft, thanks for getting back to me! 🙏🏻 🚀 No problem at all; I will try to find another reviewer. If I can't find one by mid-April, I might ping you again.

Appreciate your feedback! You're right about the length of the paper. Once we get into the review process, I'll make sure to give the author some pointers on that.

@Nikoleta-v3
Copy link

@editorialbot add @parikshitbajpai as reviewer

@editorialbot
Copy link
Collaborator Author

@parikshitbajpai added to the reviewers list!

@Nikoleta-v3
Copy link

@corettialessandro @shivupa would any of you be willing to review this submission for JOSS?

We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

The submission I'd like you to review is titled: "STReNGTHS, a python package to model and simulate reaction-diffusion systems". You can find more information at the top of this Github issue 🆙

Please let me know if you're available 😄 Thank you!

@shivupa
Copy link

shivupa commented Mar 7, 2024

Hi I'm actually in the same situation of having low bandwidth until April, and this also feels a bit too far outside of my area of expertise. I apologize for the difficulty, but I wouldn't feel confident reviewing this work.

@Nikoleta-v3
Copy link

No problem at all @shivupa! Thank you very much for your reply 🚀

@corettialessandro
Copy link

Sorry for the late answer, I was trying to find a replacement, but I did not succeed. At the moment my schedule is really tight, so I would not be able to provide a good quality review. I am sorry.

@ThibaultFillion
Copy link

ThibaultFillion commented Mar 12, 2024

@Wrzlprmft Thank you for your feedback, I'll remove the installation instructions from the summary.
@parikshitbajpai Thank you for accepting to review the paper.
@shivupa @corettialessandro No problem, thank you for taking the time to answer, and thank you @corettialessandro for having searched for a replacement.

@Nikoleta-v3
Copy link

Nikoleta-v3 commented Mar 14, 2024

Thank you both for your replies! No problem at all 😄 I really hope things become a bit less hectic for you in the next month!

Hi I'm actually in the same situation of having low bandwidth until April, and this also feels a bit too far outside of my area of expertise. I apologize for the difficulty, but I wouldn't feel confident reviewing this work.

Sorry for the late answer, I was trying to find a replacement, but I did not succeed. At the moment my schedule is really tight, so I would not be able to provide a good quality review. I am sorry.

@Nikoleta-v3
Copy link

👋🏻 @jakryd @maxscheurer would any of you be willing to review this submission for JOSS?

We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

The submission I'd like you to review is titled: "STReNGTHS, a python package to model and simulate reaction-diffusion systems". You can find more information at the top of this Github issue 🆙

Please let me know if you're available 😄 Thank you!

@jakryd
Copy link

jakryd commented Mar 15, 2024

Sure! I would be happy to review this.

@Nikoleta-v3
Copy link

@editorialbot add @jakryd as reviewer

@editorialbot
Copy link
Collaborator Author

@jakryd added to the reviewers list!

@Nikoleta-v3
Copy link

@editorialbot start review

@editorialbot
Copy link
Collaborator Author

OK, I've started the review over in #6495.

@ThibaultFillion
Copy link

@jakryd Thank you for accepting !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C++ pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

9 participants