Skip to content

JOSS paper feedback #24

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
5 tasks done
leahmendelson opened this issue May 28, 2022 · 1 comment
Closed
5 tasks done

JOSS paper feedback #24

leahmendelson opened this issue May 28, 2022 · 1 comment

Comments

@leahmendelson
Copy link

leahmendelson commented May 28, 2022

I'll consolidate my feedback on the JOSS software paper here. Overall, I'm excited about this software and have primarily minor comments on the paper.

Major:

  • "State of the field" review criteria (Do the authors describe how this software compares to other commonly-used packages?): Most comparisons in the paper are to OpenPTV, which makes sense for this project, but more comparisons (e.g., ImageJ ParticleTracker, OpenLPT) could be valuable to users trying to decide what software to use

Minor:

  • The "Tests" heading is slightly confusing in this context, can you make clearer you're referring to an example experiment implementation and not a summary of the software test cases?
  • Please directly state your working fluid (I'm assuming water, which makes that calibration error even more impressive, but this should be included in the setup details) somewhere in the experiment description

Typos:

  • Line 41 - extra _ (or formatting error) in one mention of MyPTV
  • Line 158 - incomplete reference journal title (also in user manual)
@ronshnapp
Copy link
Owner

Thank you very much for these comments!
I extended the "state of the field" to include the 2D tracking packages and the recent OpenLPT.
I also changed the title of the "Tests" section to "Testing MyPTV in an experiment".
The experiment was indeed performed in water, and I added this information to the paper.
I also fixed the typos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants