temmy222 / PyTOUGHREACT

MIT License
6 stars 1 forks source link

JOSS review: JOSS paper #18

Closed frank1010111 closed 5 months ago

frank1010111 commented 5 months ago

Is your feature request related to a problem? Please describe.

This is part of an ongoing JOSS review, specifically about the paper.

Describe the solution you'd like

As outlined in the submission guidelines provided to authors, the JOSS paper (the compiled PDF associated with this submission) should only include:

Note the paper *should not* include software documentation such as API (Application Programming Interface) functionality, as this should be outlined in the software documentation.

Aligning the manuscript with the guidelines

  1. I consider the architecture and examples to be software documentation and think they should be moved from the paper to the sphinx-generated documentation. They're great, just not meant for the paper
  2. At the moment, the introduction is a blend of a statement of need, purpose, and description of other tools, all in one paragraph. Ideally, it would be broken up into at least three paragraphs:
    • "PyTOUGHREACT is..." - high level functionality and purpose
    • "Other tools working with TOUGH include..." - comparison to other packages, such as PyTOUGH, PetraSim, TOUGH2VIEWER, etc
    • "PyTOUGHREACT has enabled us to..." - list the research projects you've completed or started thanks to your tool.
temmy222 commented 5 months ago

Hi @frank1010111 . I have made adjustments to the paper

1) I have moved the architecture and examples out of the paper and into the documentations or in the repo 2) The introduction has been broken down to three sections to reflect the points you highlighted.

Thank you