openjournals / joss-reviews

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

[PRE REVIEW]: wmpy-power: A Python package for process-based regional hydropower simulation #6808

Closed editorialbot closed 3 weeks ago

editorialbot commented 4 months ago

Submitting author: !--author-handle-->@thurber<!--end-author-handle-- (Travis Thurber) Repository: https://github.com/9505-PNNL/wmpy_power Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: !--editor-->@cheginit<!--end-editor-- Reviewers: @ijbd, @antviro Managing EiC: Kyle Niemeyer

Status

status

Status badge code:

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

Author instructions

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

@thurber 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.04 s (487.3 files/s, 99326.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                           5            210            223           1435
Markdown                         5            124              0            375
TeX                              1             10              0            105
Jupyter Notebook                 1              0           1019             72
YAML                             2             12              4             48
JSON                             1              0              0             25
Bourne Shell                     2              0              0              4
TOML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            18            356           1246           2067
-------------------------------------------------------------------------------

Commit count by author:

    15  Travis Thurber
     6  Dan Broman
editorialbot commented 4 months ago

Paper file info:

πŸ“„ Wordcount for paper.md is 719

βœ… The paper includes a Statement of need section

editorialbot commented 4 months ago

License info:

βœ… License found: BSD 2-Clause "Simplified" 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.1007/BF00939380 is OK
- 10.2172/1340431 is OK
- 10.2172/1887712 is OK
- 10.11578/dc.20211112.1 is OK
- 10.21105/joss.03221 is OK
- 10.1088/1748-9326/ac4e38 is OK
- 10.5194/hess-17-3605-2013 is OK
- 10.1088/1748-9326/aad19f is OK
- 10.1088/1748-9326/acb58d is OK

MISSING DOIs

- No DOI given, and none found for title: Multi-scale impacts of climate change on hydropowe...

INVALID DOIs

- https://doi.org/10.1016/j.jhydrol.2021.126843 is INVALID because of 'https://doi.org/' prefix
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:

kyleniemeyer commented 4 months ago

Hello @thurber, unfortunately we do not have any editors available to handle your submission right now, so I have to put this on our waitlist until someone frees up.

In the meantime, reviewer recommendations would be welcome (just please don't formally tag anyone with @).

thurber commented 3 months ago

No worries @kyleniemeyer and thanks for the update!

Here are some potential reviewer recommendations from the list:

kyleniemeyer commented 3 months ago

@editorialbot invite @AdamRJensen as editor

Hi @AdamRJensen, could you edit this?

editorialbot commented 3 months ago

Invitation to edit this submission sent!

AdamRJensen commented 3 months ago

Hi @AdamRJensen, could you edit this?

@kyleniemeyer I'm currently at capacity with my other submissions unfortunately.

Also the documentation of the package does not seem to be very well done and the scope is rather limited - should probably be checked for scope

kyleniemeyer commented 2 months ago

@editorialbot query scope

Hi @thurber, per @AdamRJensen's recommendation, we're going to take another look at the scope of the software. I would recommend thinking about documentation - I see right now that the README is quite long with some of that, but in general it would be best to create dedicated documentation and just include some basic information in the README.

editorialbot commented 2 months ago

Submission flagged for editorial review.

kyleniemeyer commented 3 weeks ago

Hello @thurber, sorry for the delay hereβ€”we will move forward with reviewing your submission, although one thing the editorial board noted was a need for improving the documentation, including adding some examples. I recommend beginning to work on this, as reviewers will also point it out.

kyleniemeyer commented 3 weeks ago

@editorialbot invite @cheginit as editor

Hi @cheginit, would you be able to edit this submission? @crvernon suggested you might be a good fit for it, even though you are not "formally" listed in the PE track.

editorialbot commented 3 weeks ago

Invitation to edit this submission sent!

cheginit commented 3 weeks ago

@kyleniemeyer Yes, I can edit the submission.

kyleniemeyer commented 3 weeks ago

@editorialbot assign @cheginit as editor

Great, thank you!

editorialbot commented 3 weeks ago

Assigned! @cheginit is now the editor

cheginit commented 3 weeks ago

πŸ‘‹πŸΌ @antviro and @ijbd, Would you like to review this submission to the Journal for Open Source Software? Our reviews are checklist-driven and openly conducted on GitHub over a timeline of 4–6 weeks. Because the process is much more iterative and interactive than a traditional paper review, we would ask you to start within the next 2 weeks. Here are reviewer guidelines for reference: joss.readthedocs.io/en/latest/reviewer_guidelines.html

Thanks for your consideration.

ijbd commented 3 weeks ago

Hi,

I would like to help review this submission. I can start this coming week if that is alright?

On Tue, Sep 10, 2024 at 11:58β€―AM Taher Chegini @.***> wrote:

πŸ‘‹πŸΌ @antviro https://github.com/antviro and @ijbd https://github.com/ijbd, Would you like to review this submission to the Journal for Open Source Software? Our reviews are checklist-driven and openly conducted on GitHub over a timeline of 4–6 weeks. Because the process is much more iterative and interactive than a traditional paper review, we would ask you to start within the next 2 weeks. Here are reviewer guidelines for reference: joss.readthedocs.io/en/latest/reviewer_guidelines.html

Thanks for your consideration.

β€” Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/6808#issuecomment-2341344890, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOQCZCVOZAKK63O2U5M3GQLZV4JH3AVCNFSM6AAAAABIRL5L5OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNBRGM2DIOBZGA . You are receiving this because you were mentioned.Message ID: @.***>

antviro commented 3 weeks ago

Ok, I can also review it.

cheginit commented 3 weeks ago

@antviro and @ijbd, Awesome, thank you! I will open a new issue with instruction to begin the review.

cheginit commented 3 weeks ago

@editorialbot add @ijbd as reviewer

editorialbot commented 3 weeks ago

@ijbd added to the reviewers list!

cheginit commented 3 weeks ago

@editorialbot add @antviro as reviewer

editorialbot commented 3 weeks ago

@antviro added to the reviewers list!

cheginit commented 3 weeks ago

@editorialbot start review

editorialbot commented 3 weeks ago

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/7225.