search

passaH2O / dorado

For shallow-water Lagrangian particle routing.
https://passah2o.github.io/dorado
MIT License
54 stars 9 forks source link

JOSS review: Improve statement of need #7

Closed kbarnhart closed 4 years ago

kbarnhart commented 4 years ago

From @dbuscombe-usgs's JOSS review link to comment

openjournals/joss-reviews/issues/2585

The statement of need should lead with a definition of the term ‘particle tracking’. It is clear to me that this is shorthand for ‘tracking of water – including particles – in a Lagrangian framework’, but it could be clearer to the reader. I also recommend adding the theory section in the documentation to the paper (https://passah2o.github.io/dorado/background/index.html). It is well written and answers many outstanding questions I have when left with when reading the paper on its own.

elbeejay commented 4 years ago

@gassmoeller left a comment on the statement as well (link to original comment):

You provide a clear statement of need, but I would prefer if you could specify the target audience a bit more clearly. It seems you are aiming at small- to medium-scale particle models and rapid development and use rather than high-performance and massively parallel models, is that correct? If so, please state.

elbeejay commented 4 years ago

Hello, we didn't want to automatically close the PR with the merge of #15 but we do believe we've addressed these concerns, and hopefully have made the paper stronger in the process. A new rendered version of the paper is available here.

We've made the following changes:

  1. To improve the statement of need, we try to make it more clear that "particle tracking" is analogous to the tracking of water parcels, and we state that the gap we are aiming to fill is specifically for doing this in a Lagrangian framework. To clarify the use-case and scale of problem, we state that this package is meant for "meant for rapid application in conjunction with any landscape-scale 2D hydrodynamic model"

  2. We have added some of the theory behind the weighted random walk scheme into the paper "Background" section.

gassmoeller commented 4 years ago

Thanks, the new statement of need looks great, this can be closed from my point of view (I cant close, because it is not my issue).