Software paper - Githubissues

husseinaluie / FlowSieve

FlowSieve coarse-graining code base

https://flowsieve.readthedocs.io/en/latest/

Other

18 stars 9 forks source link

Software paper #9

Closed NoraLoose closed 1 year ago

NoraLoose commented 2 years ago

JOSS requires the software paper to include the following elements:

[x] Summary of software: While your summary section is a great motivation for why coarse graining is needed, it does not describe the high-level functionality and purpose of the software (but rather of the technique coarse graining in general). Could you adapt the summary to be more specific to the software package FlowSieve?
[ ] State of the field: Could you include a discussion on how FlowSieve compares to other commonly-used packages?

This issue is part of the JOSS review process over https://github.com/openjournals/joss-reviews/issues/4277.

bastorer commented 2 years ago

I've updated the paper with "Summary of Software" and "State of the Field" sections added.

NoraLoose commented 2 years ago

Thanks for adding these sections! I think they will really help the reader understand better what FlowSieve is all about.

It would be nice if you could add a citation for the GCM-Filters package. :)

bastorer commented 2 years ago

Absolutely, I'm not sure why I didn't include the reference to begin with, sorry!

I've now included a reference to GCM-Filters, as well as a reference to the structure function approach ( via Dhruv's cascade paper on arxiv ).

NoraLoose commented 1 year ago

These are the references that the GCM-Filters developers recommend to cite: https://gcm-filters.readthedocs.io/en/latest/how_to_cite.html

As for the structure function reference, I would also cite some more elementary work that describes structure functions (rather than just uses them), such as

U. Frisch, Turbulence: the legacy of A. N. Kolmogorov (Cambridge university press, 1995).

bastorer commented 1 year ago

Thanks for pointing those out. Paper references have been updated accordingly.