search

csdms / babelizer

Transform BMI-wrapped models into Python packages
https://babelizer.readthedocs.io
MIT License
4 stars 3 forks source link

JOSS review: Readme suggestions #50

Closed lheagy closed 2 years ago

lheagy commented 3 years ago

These are a few suggestions for the README + intro page on the docs as a part of the JOSS review (openjournals/joss-reviews#3344). The README has a great, easy to follow set of instructions for installation! What I think could be improved though is the description of the package and who should be using it (e.g. to satisfy the "Statement of need" requirement in the JOSS documentation checklist). I appreciate it is a part of the larger CSDMS workbench, so a bit more context in the high level summary on where this project fits would be helpful for users to get a sense of if they are in the right place or if they should be looking at another repository in the CSDMS ecosystem. The summary in the paper is a good overview!

mdpiper commented 2 years ago

Hi @lheagy -- @mcflugen attempted to address this issue in #57. (It may be easier to view the resulting README.rst in the develop branch.) Please let us know if these changes satisfy the concerns raised in this issue.

mdpiper commented 2 years ago

Fixed with #57.