[PRE REVIEW]: RiverFlowDynamics v1.0: A Landlab component for computing two-dimensional river flow dynamics

[editorialbot]

Submitting author: @angelmons (Angel Monsalve)
Repository: https://github.com/landlab/landlab
Branch with paper.md (empty if default branch):
Version: v1.0
Editor: Pending
Reviewers: Pending
Managing EiC: Kristen Thyng

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/67f225c623d4d1b18414572c14435c02"><img src="https://joss.theoj.org/papers/67f225c623d4d1b18414572c14435c02/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/67f225c623d4d1b18414572c14435c02/status.svg)](https://joss.theoj.org/papers/67f225c623d4d1b18414572c14435c02)

Author instructions

Thanks for submitting your paper to JOSS @angelmons. Currently, there isn't a JOSS editor assigned to your paper.

@angelmons if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.5194/esurf-5-21-2017 is OK
- 10.5194/esurf-2020-12 is OK
- 10.1016/j.geomorph.2018.08.031 is OK
- 10.1002/esp.4195 is OK
- 10.1002/2014WR016862 is OK
- 10.1002/2016JF003965 is OK
- 10.1002/esp.4635 is OK
- 10.1080/00221686.2006.9521683 is OK
- 10.1080/00221686.2006.9521684 is OK
- 10.1002/rra.1012 is OK
- 10.1061/(ASCE)0733-9429(2003)129:2(120) is OK
- 10.1029/2006WR005330 is OK
- 10.1029/97WR02387 is OK
- 10.1002/2015JF003491 is OK
- 10.1029/2006WR005172 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: 1D SEDIMENT TRANSPORT MORPHODYNAMICS with applicat...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=1.09 s (759.4 files/s, 214531.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         573          24367          51181          78148
Markdown                        78           2359              0          14676
Jupyter Notebook                94              0          33466          10993
TOML                             3            794              5           8344
Cython                          48           1089           1364           5502
TeX                              5             70              0            786
YAML                            10             89             38            561
DOS Batch                        1             29              1            212
Bourne Shell                     1             12             12             31
make                             1              4              6             12
Jinja Template                   1              5              0             10
XML                              4              0              0              8
SVG                              7              0              0              7
C/C++ Header                     1              2              4              5
reStructuredText                 1              1              0              4
HTML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                           829          28821          86077         119302
-------------------------------------------------------------------------------

Commit count by author:

  3894	Eric Hutton
  1118	Katy Barnhart
  1015	Dan Hobley
   878	Greg Tucker
   321	dependabot[bot]
   257	Jordan Adams
   256	Sai Nudurupati
   227	Nicole M Gasparini
    70	pre-commit-ci[bot]
    69	Charlie Shobe
    62	David Litwin
    59	Laurent Roberge
    49	Ronda Strauch
    44	Jenny Knuth
    43	Benjamin Campforts
    43	Sebastien Lenard
    40	Margaux Mouchene
    27	Nathan Lyons
    26	Berkan M
    18	Jeffrey Keck
    17	Allison Pfeiffer
    14	angelmons
    12	Rachel Glade
    11	Dylan Ward
    11	Giuseppecipolla95
     7	Annie Thompson
     6	Mark Piper
     2	Amanda Manaster
     2	Jay Hariharan
     2	Shelby Ahrendt
     1	(no author)
     1	Abby Langston
     1	Andy Wickert
     1	Christopher Sheehan
     1	Josh Wolpert
     1	Kristen Thyng
     1	Muneer Ahammad
     1	Sarah Lundell
     1	pankajiitkgp

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1530

🔴 Failed to discover a Statement of need section in paper

[editorialbot]

License info:

✅ License found: MIT License (Valid open source OSI approved license)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

pySBeLT: A Python software package for stochastic sediment transport under rarefied conditions
Submitting author: @szwiep
Handling editor: @kbarnhart (Retired)
Reviewers: @pfeiffea, @tdoane
Similarity score: 0.7735

dorado: A Python package for simulating passive particle transport in shallow-water flows
Submitting author: @elbeejay
Handling editor: @kbarnhart (Retired)
Reviewers: @dbuscombe-usgs, @gassmoeller
Similarity score: 0.7031

The Kestrel software for simulations of morphodynamic Earth-surface flows
Submitting author: @jakelangham
Handling editor: @crvernon (Active)
Reviewers: @mdpiper, @jatkinson1000
Similarity score: 0.6973

pyDeltaRCM: a flexible numerical delta model
Submitting author: @amoodie
Handling editor: @kbarnhart (Retired)
Reviewers: @zsylvester, @jhnienhuis, @salterg
Similarity score: 0.6973

GroundwaterDupuitPercolator: A Landlab component for groundwater flow
Submitting author: @davidlitwin
Handling editor: @kthyng (Active)
Reviewers: @dvalters, @rreinecke
Similarity score: 0.6868

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[kthyng]

Hi @angelmons and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

• OSI-approved license
• Installation instructions
• Documentation exists at all
• Tests of some sort
• Check paper (make sure compiles, read through, check for length 250-1000 words)
• Substantial scholarly effort
• Clear research application

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

[kthyng]

@angelmons It's been awhile since I've seen a landlab submission come through, but am I correct in thinking that the number of lines of code shown above is for all of landlab, but you are submitting on a specific module? If so, please provide more information so we can find the correct numbers for the relevant work.

[angelmons]

Hello @kthyng,
Thank you for your review and questions. I'd like to clarify that we are submitting a specific component called RiverFlowDynamics, which is integrated into the Landlab platform. You are correct that the code metrics shown above reflect the entire Landlab codebase rather than our specific component.

Regarding the submission requirements:

1. Our component is covered under Landlab's MIT license, which is OSI-approved.
2. The component is fully integrated into Landlab's official documentation system, including:
    - Detailed installation instructions as part of Landlab
    - Component-specific documentation
    - Comprehensive test suite
3. Regarding the paper:

    - It is located at: https://github.com/landlab/landlab/blob/master/joss/in_preparation/river_flow_dynamics/paper.md
    - The current word count is approximately 1150 words, which we can adjust if needed during the review process
    - The paper and code demonstrate substantial scholarly effort, representing years of research and development
    - We clearly outline the research applications and potential impact

I noticed that the editorialbot is analyzing Pfeiffer et al. (2020) NetworkSedimentTransporter component in the published folder, rather than our RiverFlowDynamics component submission located in the in_preparation folder. This may explain the discrepancy in the code metrics being reported.

Would you like me to provide any additional information about our component or clarify any specific aspects of the submission?

Regarding potential reviewers: I would suggest: zsylvester, ebgoldstein, pfeiffea, nicgaspar

[angelmons]

@angelmons It's been awhile since I've seen a landlab submission come through, but am I correct in thinking that the number of lines of code shown above is for all of landlab, but you are submitting on a specific module? If so, please provide more information so we can find the correct numbers for the relevant work.

Hello @kthyng,
I hope you're having a good week. I wanted to gently follow up on our submission and check if you need any additional information from us regarding the RiverFlowDynamics component. We're happy to provide more details or clarification if needed.

Best regards.