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]: TauFactor 2: A GPU accelerated python tool for microstructural analysis #5358

Closed
editorialbot opened this issue Apr 12, 2023 · 82 comments
Assignees
Labels
accepted Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Apr 12, 2023

Submitting author: @stke9 (Steven Kench)
Repository: https://github.com/tldr-group/taufactor
Branch with paper.md (empty if default branch): main
Version: v1.1.0
Editor: @zhubonan
Reviewers: @alexsquires, @ma-sadeghi
Archive: 10.5281/zenodo.8177306

Status

status

Status badge code:

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

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

@alexsquires & @ma-sadeghi, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @zhubonan 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

Checklists

📝 Checklist for @ma-sadeghi

📝 Checklist for @alexsquires

@editorialbot editorialbot added Makefile Python review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode. labels Apr 12, 2023
@editorialbot
Copy link
Collaborator Author

Hello humans, 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.09 s (377.4 files/s, 28324.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          10            239            304            988
Markdown                         8            177              0            372
TeX                              1             13              0            199
YAML                             6             18             35             81
make                             2             24              6             75
DOS Batch                        1              8              1             27
INI                              1              4              3             20
reStructuredText                 5              3             17              7
TOML                             1              0              0              6
-------------------------------------------------------------------------------
SUM:                            35            486            366           1775
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1173

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1051/0004-6361/201629272 is OK
- 10.1051/0004-6361/201322068 is OK
- 10.1051/0004-6361/201629272 is OK
- 10.1016/j.softx.2021.100729 is OK
- 10.1016/j.softx.2016.09.002 is OK
- 10.1016/s1386-5056(98)00163-4 is OK
- 10.1111/gwat.12406 is OK
- 10.1149/2.0231803jes is OK
- 10.1002/aenm.202370009 is OK
- 10.1038/s41597-022-01744-1 is OK
- 10.1038/s41524-020-00386-4 is OK
- 10.1016/j.electacta.2017.07.152 is OK
- 10.1016/j.coche.2016.02.006 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@ma-sadeghi
Copy link

ma-sadeghi commented Apr 12, 2023

Review checklist for @ma-sadeghi

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 https://github.com/tldr-group/taufactor?
  • 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 (@stke9) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • 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?

@alexsquires
Copy link

alexsquires commented Apr 13, 2023

Review checklist for @alexsquires

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 https://github.com/tldr-group/taufactor?
  • 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 (@stke9) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • 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?

@alexsquires
Copy link

alexsquires commented Apr 19, 2023

Hi @stke9 before raising any technical points as issues on the repo itself I just wanted to check an admin point.

I'm certain there is a straightforward explanation for this, I just want to do due diligence!

With regards to the point:

Contribution and authorship: Has the submitting author (@stke9) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Could you clarify the contributions of the paper authors as going off the repo alone it is not clear.

@alexsquires
Copy link

alexsquires commented May 4, 2023

@stke9
Copy link

stke9 commented May 15, 2023

Hi Alex, thanks so much for all your comments, was so useful to have some fresh eyes on the repo. WRT authorship, we have added the following:

'SK wrote the base, periodic and multiphase solvers with input from IS. IS wrote the electrode solver, metric calculations and documentation, and also performed speed tests for other software packages. The project was supervised by SC, and based on his original MATLAB tool. All authors contributed to the writing and editing of the manuscript.'

I moved lots of the code from a different repo i was working in to our groups gh, which is why i have v few contributions!

Let us know how the speed testing is coming along!

@alexsquires
Copy link

I suspected that or similar may have been the case, thanks for clarifying.

Aiming to complete the speed test by the end of tomorrow, and then I will have checked everything off.

@alexsquires
Copy link

Just a heads up as I said I would finish this today, I have been waiting for one of our institutions machine with lots of GPUs to come back online after some down time to run my tests. It's back and they are in the queue, hopefully they will run tonight, and then I can check this off!

@stke9
Copy link

stke9 commented May 18, 2023

No worries, let us know if you come across any issues!

@alexsquires
Copy link

alexsquires commented May 18, 2023 via email

@alexsquires
Copy link

Hi @zhubonan,

I'm done! Looks good to me.

@ma-sadeghi
Copy link

ma-sadeghi commented May 23, 2023

Sorry for the wait, I'm about to finish my review, I'll update this thread.

@zhubonan
Copy link

zhubonan commented Jun 6, 2023

@ma-sadeghi how is it going? BTW, If you have any update/concerns, please feel free to post them here.

@zhubonan
Copy link

@ma-sadeghi Just want to give a gentle reminder as the review is pending. I am looking forward to your comments. Would you be able to finish it in two weeks? If not, it would be great if you can let me know the time frame. Thanks a lot.

@ma-sadeghi
Copy link

@zhubonan I really apologize that I dropped the ball on this. I'm swamped at the moment, but that's no excuse.

Anyway, I will finish this in two weeks, I almost want to make a promise to do it sooner, but for the sake of not embarrassing myself again, let's aim for the two week window.

Thank you so much for your patience :)

@zhubonan
Copy link

@ma-sadeghi Thanks for doing the review.

@stke9
Copy link

stke9 commented Jun 29, 2023

Thanks @ma-sadeghi really useful comments! Most issues resolved I think, just two to look (see your above list of issues). Cheers!

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1051/0004-6361/201629272 is OK
- 10.1051/0004-6361/201322068 is OK
- 10.1051/0004-6361/201629272 is OK
- 10.1016/j.softx.2021.100729 is OK
- 10.1016/j.softx.2016.09.002 is OK
- 10.1016/s1386-5056(98)00163-4 is OK
- 10.1111/gwat.12406 is OK
- 10.1149/2.0231803jes is OK
- 10.1002/aenm.202370009 is OK
- 10.1038/s41597-022-01744-1 is OK
- 10.1038/s41524-020-00386-4 is OK
- 10.1016/j.electacta.2017.07.152 is OK
- 10.1016/j.coche.2016.02.006 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

⚠️ Error preparing paper acceptance. The generated XML metadata file is invalid.

No declaration for attribute displaystyle of element mfrac
No declaration for attribute displaystyle of element mfrac
No declaration for attribute displaystyle of element mfrac

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev can you help here ☝️

@xuanxu
Copy link
Member

xuanxu commented Aug 3, 2023

The errors come from the math equations code using displaymode with \dfrac. It looks like that function is not fully supported by our compilation tool. This PR modifies the code for the equations, and running recommend-accept after is merged should work (or at least don't display those same errors).

@isaacsquires
Copy link

Have merged the PR!

@zhubonan
Copy link

zhubonan commented Aug 4, 2023

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1051/0004-6361/201629272 is OK
- 10.1051/0004-6361/201322068 is OK
- 10.1051/0004-6361/201629272 is OK
- 10.1016/j.softx.2021.100729 is OK
- 10.1016/j.softx.2016.09.002 is OK
- 10.1016/s1386-5056(98)00163-4 is OK
- 10.1111/gwat.12406 is OK
- 10.1149/2.0231803jes is OK
- 10.1002/aenm.202370009 is OK
- 10.1038/s41597-022-01744-1 is OK
- 10.1038/s41524-020-00386-4 is OK
- 10.1016/j.electacta.2017.07.152 is OK
- 10.1016/j.coche.2016.02.006 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4453, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Aug 4, 2023
@stke9
Copy link

stke9 commented Aug 4, 2023

All looks good to us!

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Aug 8, 2023

@stke9 I have checked the paper, this review, your repository, and the archive, and all seems in order. However I did find a minor typo in the paper which you can fix:

  • Fix calaculated -> calculated

Next I noticed you say Materials characterisation..., the plural "materials", may be intentional, but check if this should be Material characterisation.... Feel free to ignore if this was intentional.

@isaacsquires
Copy link

The 'calaculated' typo has been fixed by the latest PR. The plural in materials is intentional, 'materials science' and 'materials characterisation' is our preferred syntax.

@zhubonan
Copy link

zhubonan commented Aug 9, 2023

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: Kench
  given-names: Steve
  orcid: "https://orcid.org/0000-0002-7263-6724"
- family-names: Squires
  given-names: Isaac
  orcid: "https://orcid.org/0000-0003-1919-061X"
- family-names: Cooper
  given-names: Samuel
  orcid: "https://orcid.org/0000-0003-4055-6903"
contact:
- family-names: Cooper
  given-names: Samuel
  orcid: "https://orcid.org/0000-0003-4055-6903"
doi: 10.5281/zenodo.8177306
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Kench
    given-names: Steve
    orcid: "https://orcid.org/0000-0002-7263-6724"
  - family-names: Squires
    given-names: Isaac
    orcid: "https://orcid.org/0000-0003-1919-061X"
  - family-names: Cooper
    given-names: Samuel
    orcid: "https://orcid.org/0000-0003-4055-6903"
  date-published: 2023-08-09
  doi: 10.21105/joss.05358
  issn: 2475-9066
  issue: 88
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5358
  title: "TauFactor 2: A GPU accelerated python tool for microstructural
    analysis"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05358"
  volume: 8
title: "TauFactor 2: A GPU accelerated python tool for microstructural
  analysis"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 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.05358 joss-papers#4461
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05358
  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...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Aug 9, 2023
@Kevin-Mattheus-Moerman
Copy link
Member

@stke9 congratulations on this JOSS publication!

Thanks for editing this one @zhubonan!

And a special thanks to the reviewers @alexsquires and @ma-sadeghi !

@editorialbot
Copy link
Collaborator Author

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

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

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

This is how it will look in your documentation:

DOI

We need your help!

The 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 Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.
Projects
None yet
Development

No branches or pull requests

8 participants