search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
707 stars 37 forks source link

[PRE REVIEW]: Flood Resilience Digital Twin: A system to enable flood risk analysis and prediction #6664

Closed editorialbot closed 3 months ago

editorialbot commented 4 months ago

Submitting author: !--author-handle-->@LukeParky<!--end-author-handle-- (Luke Parkinson) Repository: https://github.com/GeospatialResearch/Digital-Twins Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: Daniel S. Katz

Status

status

Status badge code:

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

Author instructions

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

@LukeParky 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 commented 4 months ago

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 commented 4 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.40 s (695.4 files/s, 451342.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                            16              0              0         130014
HTML                            79           2171            235          20209
Python                          52           1369           5240           4111
SVG                              1              0              0           2671
JavaScript                      15            140            233            969
CSS                              6            198             51            824
YAML                             8             61             18            704
reStructuredText                75           3521           4541            546
Markdown                         5             83              0            323
Vuejs Component                  4             16             39            275
TeX                              1             16              0            157
Dockerfile                       2             33             32             88
TypeScript                       6             13             19             69
Bourne Shell                     3             13             11             41
Scheme                           1              0              0             28
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                           276           7646          10427         161064
-------------------------------------------------------------------------------

Commit count by author:

  1205  Casey Li
   356  Luke Parkinson
   135  Pooja3894
   103  Pooja Khosla
    37  Rose Pearson
    22  PoojaKhosla
    13  Xander Cai
     5  xandercai
     4  Casey
     3  Angus L
     2  sli229
     1  UOCNT
editorialbot commented 4 months ago

Paper file info:

📄 Wordcount for paper.md is 1245

✅ The paper includes a Statement of need section

editorialbot commented 4 months ago

License info:

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

editorialbot commented 4 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.envsoft.2023.105842 is OK
- 10.3390/ijerph18083952 is OK
- 10.1080/17477891.2022.2142500 is OK
- 10.1038/s41467-022-30725-6 is OK
- 10.1080/03036758.2023.2211777 is OK
- 10.1080/19475705.2018.1552630 is OK

MISSING DOIs

- No DOI given, and none found for title: Flood Resilience Digital Twin (FReDT)
- No DOI given, and none found for title: BG Flood
- No DOI given, and none found for title: Mā te haumaru ō ngā puna wai ō Rākaihautū ka ora m...
- No DOI given, and none found for title: Flooding Brings Deep Trouble
- No DOI given, and none found for title: Climate Change Implications for New Zealand
- No DOI given, and none found for title: Hydrological projections for New Zealand rivers un...
- No DOI given, and none found for title: Hirds.v3: High Intensity Rainfall Design System – ...
- No DOI given, and none found for title: Towards a National Digital Twin for Flood Resilien...
- 10.21203/rs.3.rs-1123016/v1 may be a valid DOI for title: RiskScape: A flexible multi-hazard risk modelling ...
- No DOI given, and none found for title: Regional Flood Estimation Tool for New Zealand Par...
- No DOI given, and none found for title: Regional Flood Estimation Tool for New Zealand Par...

INVALID DOIs

- None
editorialbot commented 4 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

danielskatz commented 4 months ago

👋 @LukeParky - Thanks for your submission. I think it's ended up in the wrong track, and we're currently discussing moving it, so that the right AEiC can get things started.

In the meantime, you could work on the possibly missing DOI that editorialbot suggests, but note that this may be incorrect. Please feel free to make changes to your .bib file, then use the command @editorialbot check references to check again, and the command @editorialbot generate pdf when the references are right to make a new PDF. editorialbot commands need to be the first entry in a new comment.

kthyng commented 4 months ago

Hi @LukeParky 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:

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 commented 4 months ago

@lukeparky

kthyng commented 4 months ago

@editorialbot query scope

editorialbot commented 4 months ago

Submission flagged for editorial review.

LukeParky commented 4 months ago

@kthyng

  • Can a user run this software without docker, say, for development purposes? I see your instructions for running locally but it looks like they still involve docker.

It is possible to run without Docker, for development purposes, but we reccomend running docker containers for at least the components that do not form the main codebase, such as the database, redis and geoserver. We have provided documentation for this setup in the wiki, but have not provided documentation of how one would set up these services without Docker.

  • Is there documentation beyond the API docs?

The current documentation includes:

  • I need to ping the editorial board to see if this submission is in scope due to being a web application. We are in the midst of improving our guidelines for web applications. This will take a few weeks as we deliberate, thanks for your patience.

Thank you for letting me know, if there is anything I can do to help answer for this editorial review please let me know. We have other open source web applications for self hosting that we are considering submitting papers for so it would be good to hear back from you.

LukeParky commented 4 months ago

Just to follow up about this. This specific paper is a bout a system that is intended to be integrated into existing tooling such as GIS software, acting as a data store and processing pipeline. It has a web app attached to it but it is more than just a website.

Happy to discuss more once the editors have had more time to review.

kthyng commented 4 months ago

@LukeParky This has passed our scope query, though all the editors who voted wondered if there could be a live demo available and why there wasn't one.

Despite your list of docs, they still seem a bit light, but perhaps that will come up more during review.

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.

We have a backlog of submissions so I will add this to our waitlist. Thanks for your patience.

LukeParky commented 4 months ago

Hi @kthyng, we have noticed some issues that we would like to address before carrying on with review, but it may be a couple of weeks before we can address them.

Is it best to resubmit once we have fixed the issues?

kthyng commented 3 months ago

@LukeParky Sorry I missed this note. Have you been able to address your issues?

kthyng commented 3 months ago

If not, yes probably best to withdraw then resubmit and link to this issue for context.

kthyng commented 3 months ago

@LukeParky Any follow up?

kthyng commented 3 months ago

I am going to pause this submission while we wait to hear back from you.

LukeParky commented 3 months ago

Hello @kthyng, I'd like to withdraw and resubmit later. I am not sure how to withdraw.

kthyng commented 3 months ago

I will do it for you. Please reference this github issue if and when you resubmit. Thanks.

kthyng commented 3 months ago

@editorialbot withdraw

editorialbot commented 3 months ago

Paper withdrawn.