openjournals / joss-reviews

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

[PRE REVIEW]: PyHD - PyHeatDemand - Processing Tool for Heat Demand Data #6041

Closed editorialbot closed 5 months ago

editorialbot commented 8 months ago

Submitting author: !--author-handle-->@AlexanderJuestel<!--end-author-handle-- (Alexander Jüstel) Repository: https://github.com/AlexanderJuestel/pyhd Branch with paper.md (empty if default branch): Version: v0.0.1 Editor: !--editor-->@timtroendle<!--end-editor-- Reviewers: @nmstreethran, @samuelduchesne Managing EiC: Kyle Niemeyer

Status

status

Status badge code:

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

Author instructions

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

@AlexanderJuestel 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 8 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 8 months ago
Software report:

github.com/AlDanial/cloc v 1.88  T=0.08 s (553.7 files/s, 242682.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Jupyter Notebook                13              4          15643            852
Python                           4            327            373            704
reStructuredText                 7            194             97            441
Markdown                        10            130              0            421
YAML                             9             25             29            198
TeX                              1             19              0            181
TOML                             1             10              6             69
-------------------------------------------------------------------------------
SUM:                            45            709          16148           2866
-------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository
editorialbot commented 8 months ago

Wordcount for paper.md is 1963

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

OK DOIs

- 10.5281/zenodo.4569086 is OK
- 10.5281/zenodo.4459137 is OK
- 10.21105/joss.01450 is OK
- 10.5281/zenodo.4572994 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5194/gmd-14-5063-2021 is OK

MISSING DOIs

- None

INVALID DOIs

- https://doi.org/10.1016/j.compenvurbsys.2017.05.004 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.rser.2020.109987 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.energy.2020.117429 is INVALID because of 'https://doi.org/' prefix
- http://dx.doi.org/10.48380/dggv-j2wj-nk88 is INVALID because of 'https://doi.org/' prefix
editorialbot commented 8 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 8 months ago

Hi @AlexanderJuestel, thanks for your interest in JOSS. Due to the relatively small size of your submission, the editorial board is going to review your submission to see if it meets our requirements for substantial scholarly effort. We should get back to you within a week or two.

kyleniemeyer commented 8 months ago

@editorialbot query scope

editorialbot commented 8 months ago

Submission flagged for editorial review.

AlexanderJuestel commented 8 months ago

@kyleniemeyer, thank you very much! Please let me know if I can provide any more information to the board to demonstrate the scholarly effort! Looking forward to hearing back from you!

AlexanderJuestel commented 8 months ago

@editorialbot commands

editorialbot commented 8 months ago

Hello @AlexanderJuestel, here are the things you can ask me to do:


# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Check the references of the paper for missing DOIs
@editorialbot check references

# Perform checks on the repository
@editorialbot check repository

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers
AlexanderJuestel commented 8 months ago

@editorialbot check references

editorialbot commented 8 months ago

Checking the BibTeX entries failed with the following error:

Failed to parse BibTeX on value ".1016/j.rser.2020.109987" (NAME) [#<BibTeX::Bibliography data=[13]>, "@", #<BibTeX::Entry >, {:title=>["Heat demand mapping and district heating assessment in data-pour areas"], :journal=>["Renewable and Sustainable Energy Reviews"], :volume=>["131"], :pages=>["109987"], :year=>["2020"], :doi=>"10"}]
AlexanderJuestel commented 8 months ago

@editorialbot check references

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

OK DOIs

- 10.5281/zenodo.4569086 is OK
- 10.5281/zenodo.4459137 is OK
- 10.21105/joss.01450 is OK
- 10.5281/zenodo.4572994 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5194/gmd-14-5063-2021 is OK
- 10.1016/j.compenvurbsys.2017.05.004 is OK
- 10.1016/j.rser.2020.109987 is OK
- 10.1016/j.energy.2020.117429 is OK
- 10.48380/dggv-j2wj-nk88 is OK

MISSING DOIs

- None

INVALID DOIs

- None
AlexanderJuestel commented 8 months ago

@kyleniemeyer, just to let you know that we are currently preparing an associated scientific publication using PyHeatDemand (just making you aware of that according to https://joss.readthedocs.io/en/latest/submitting.html#co-publication-of-science-methods-and-software). In particular, we are preparing a publication outlining the creation and evaluation of the heat demand for North West Europe within the Interreg Project DGE Rollout. Parts of the resulting heat demand map are already published on a webtool: https://data.geus.dk/egdi/?mapname=dgerolloutwebtool#baslay=baseMapGEUS&extent=805870,1093160,7699110,5372220&layers=dge_heat_final

AlexanderJuestel commented 7 months ago

Also, I implemented spatial indices with the help of the GeoPandas developers last week decreasing the computing time of the results by a factor of up to 1e6. Further, there is also some grid refinement available now, similar to a QuadTree algorithm: https://pyhd.readthedocs.io/en/latest/notebooks/14_Refining_Polygon_Mask.html

kyleniemeyer commented 7 months ago

@editorialbot check repository

editorialbot commented 7 months ago
Software report:

github.com/AlDanial/cloc v 1.88  T=0.07 s (674.6 files/s, 305348.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                           4            416            462            948
Jupyter Notebook                14              4          16284            884
reStructuredText                 7            195             98            441
Markdown                        10            130              0            426
YAML                             9             22             29            198
TeX                              1             19              0            181
TOML                             1             10              6             69
-------------------------------------------------------------------------------
SUM:                            46            796          16879           3147
-------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository
editorialbot commented 7 months ago

Wordcount for paper.md is 2000

kyleniemeyer commented 7 months ago

Hi @AlexanderJuestel, thanks for the info - we will proceed with reviewing this. Unfortunately, we don't have any editors available to handle it right now, so I have to put this on our waitlist until someone opens up.

AlexanderJuestel commented 7 months ago

@kyleniemeyer, thanks for the information. This will give me some time to revise things and make the upcoming review hopefully as smooth as possible! Thanks for all your efforts already!

Cheers Alex

AlexanderJuestel commented 7 months ago

Hello @kyleniemeyer,

I am just wondering if you have a rough timeline when a new editor may be available for handling my submission.

Have a good pre-Christmas time. Cheers Alex

AlexanderJuestel commented 7 months ago

@editorialbot generate pdf

editorialbot commented 7 months ago

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

editorialbot commented 7 months ago

Five most similar historical JOSS papers:

TESPy: Thermal Engineering Systems in Python Submitting author: @fwitte Handling editor: @kyleniemeyer (Active) Reviewers: @arosen93, @corentin-dev Similarity score: 0.8217

HydroMT: Automated and reproducible model building and analysis Submitting author: @dirkeilander Handling editor: @elbeejay (Active) Reviewers: @JannisHoch, @mcflugen, <s>@LejoFlores</s> Similarity score: 0.8198

HRDS: A Python package for hierarchical raster datasets Submitting author: @jhill1 Handling editor: @kthyng (Active) Reviewers: @edoddridge, @PythonCHB Similarity score: 0.8187

EarthPy: A Python package that makes it easier to explore and plot raster and vector data using open source Python tools. Submitting author: @lwasser Handling editor: @arfon (Active) Reviewers: @arfon Similarity score: 0.8171

diyepw: A Python package for Do-It-Yourself EnergyPlus weather file generation Submitting author: @amandadsmith Handling editor: @timtroendle (Active) Reviewers: @samuelduchesne, @fneum Similarity score: 0.8159

⚠️ 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.

kyleniemeyer commented 6 months ago

@editorialbot invite @timtroendle as editor

Hi @timtroendle, could you take this submission?

editorialbot commented 6 months ago

Invitation to edit this submission sent!

timtroendle commented 6 months ago

Yes, I am happy to.

👋 @AlexanderJuestel, I am going to search for reviewers. If you have any suggestions, please let me know.

timtroendle commented 6 months ago

@editorialbot assign me as editor

editorialbot commented 6 months ago

Assigned! @timtroendle is now the editor

timtroendle commented 6 months ago

:wave: @adamrjensen, @sevberg & @j3r3m1, would any of you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

AlexanderJuestel commented 6 months ago

Yes, I am happy to.

👋 @AlexanderJuestel, I am going to search for reviewers. If you have any suggestions, please let me know.

Hello @timtroendle, thank you very much for volunteering to edit our submission. Looking forward to making the package even better with the comments and suggestions of the reviewers!

j3r3m1 commented 6 months ago

👋 @AdamRJensen, @sevberg & @j3r3m1, would any of you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

Hi, Sorry cannot make it this time

AlexanderJuestel commented 5 months ago

@kyleniemeyer, @timtroendle just want to make you aware of a brand new publication using PyHeatDemand: https://www.mdpi.com/1996-1073/17/2/481

timtroendle commented 5 months ago

👋 @samuelduchesne, @vankesteren & @nmstreethran, would any of you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

nmstreethran commented 5 months ago

@timtroendle yes, happy to review

On Mon, 22 Jan 2024, 08:37 Tim Tröndle, @.***> wrote:

👋 @samuelduchesne https://github.com/samuelduchesne, @vankesteren https://github.com/vankesteren & @nmstreethran https://github.com/nmstreethran, would any of you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

— Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/6041#issuecomment-1903494966, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHOG4CUXZ3G5MMNGHSEJHH3YPYQNBAVCNFSM6AAAAAA7EAYQ7KVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBTGQ4TIOJWGY . You are receiving this because you were mentioned.Message ID: @.***>

samuelduchesne commented 5 months ago

Sure thing!

vankesteren commented 5 months ago

I just accepted a (very much delayed) review for a different package at JOSS, so I'll decline this one.

AlexanderJuestel commented 5 months ago

@timtroendle, then we should have two reviewers with @nmstreethran and @samuelduchesne, right?

timtroendle commented 5 months ago

@AlexanderJuestel, yes. Thanks @nmstreethran , @samuelduchesne, @vankesteren for your quick responses.

timtroendle commented 5 months ago

@editorialbot add @nmstreethran as reviewer

editorialbot commented 5 months ago

@nmstreethran added to the reviewers list!

timtroendle commented 5 months ago

@editorialbot add @samuelduchesne as reviewer

editorialbot commented 5 months ago

@samuelduchesne added to the reviewers list!

timtroendle commented 5 months ago

@editorialbot start review

editorialbot commented 5 months ago

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