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

JOSS-REVIEW: paper #39

Closed
JannisHoch opened this issue May 20, 2021 · 3 comments · Fixed by #40
Closed

JOSS-REVIEW: paper #39

JannisHoch opened this issue May 20, 2021 · 3 comments · Fixed by #40
Assignees

Comments

@JannisHoch
Copy link

Dear @thurber,

I have started reviewing the JOSS paper.

Here a few comments that should be included in a revised version:

  • In the first paragraph of the 'Statement of Need' replace 'tightly-coupled codebase' with 'code' or something that is easier to understand for a less expert audience.
  • While it's in there, I recommend to more clearly specify in 'Statement of Need' what the problem is your software aims to solve and what the intended audience is.
  • It is not clear why you include BMI functionality. Any particular use case for it?
  • Talking about BMI, I feel that you work is very close to some work of mine in which I added a BMI to various hydrological models and put them into a modelling framework (https://doi.org/10.5194/nhess-19-1723-2019). This would be a good addition to the BMI section of the paper and would fill in some content for the section 'State of the field' which is not yet really apparent in the paper.
  • As such, please add a 'State of the field' section or at least a section that covers the relevant content.
  • It is not clear whether the 'old' FORTRAN version is now replaced with the Python version or, if not, they are updated when model code changes in one of the versions. Please explain (briefly) how this refactoring of the model affects long-term model development.
  • The section 'Functionalities and limitations' is sligthly too technical for a JOSS paper (in my opinion). Please remove or rewrite it such that it appeals to a non-expert audience.

Besides these points, well-written paper and also references are fine.

Thanks for addressing these points.

@thurber
Copy link
Contributor

thurber commented May 24, 2021

Thanks for this feedback @JannisHoch! I'm going to think through how to address these points and will have a Pull Request ready in a couple days.

tagging openjournals/joss-reviews#3221 for posterity

@thurber thurber self-assigned this May 24, 2021
thurber added a commit that referenced this issue May 27, 2021
thurber added a commit that referenced this issue May 27, 2021
@thurber
Copy link
Contributor

thurber commented May 27, 2021

@JannisHoch, I updated the paper to reflect this feedback in pull request #40. Let me know what you think!

@thurber thurber linked a pull request May 28, 2021 that will close this issue
thurber added a commit that referenced this issue Jun 1, 2021
update paper based on feedback from #39
@JannisHoch
Copy link
Author

@thurber happy with the modifications!

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

Successfully merging a pull request may close this issue.

2 participants