search

openjournals / joss-reviews

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

[PRE REVIEW]: cd2es: Converting climate data to energy system input data #7216

Open editorialbot opened 2 months ago

editorialbot commented 2 months ago

Submitting author: !--author-handle-->@Schneewittchen7001<!--end-author-handle-- (Leonie Plaga) Repository: https://gitlab.ruhr-uni-bochum.de/ee/cd2es Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: !--editor-->@AdamRJensen<!--end-editor-- Reviewers: !--reviewers-list-->@ciara-donegan<!--end-reviewers-list-- Managing EiC: Kristen Thyng

Status

status

Status badge code:

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

Author instructions

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

@Schneewittchen7001 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 2 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 2 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1016/j.rser.2019.06.006 is OK
- 10.1016/j.rser.2019.04.065 is OK
- 10.1016/j.energy.2016.08.068 is OK
- 10.5281/zenodo.5614769 is OK
- 10.1016/j.apenergy.2018.09.084 is OK
- 10.1016/j.apenergy.2022.120384 is OK
- 10.1109/EEM54602.2022.9921057 is OK
- 10.1016/j.energy.2016.08.060 is OK
- 10.24381/cds.e2161bac is OK
- 10.1016/j.rser.2014.09.041 is OK
- 10.1007/s10113-013-0499-2 is OK
- 10.21105/joss.00884 is OK
- 10.21105/joss.03294 is OK
- 10.1038/s41597-023-02494-4 is OK
- 10.1002/2017GL076222 is OK
- 10.1016/j.apenergy.2017.03.001 is OK
- 10.1175/JCLI-D-14-00754.1 is OK
- 10.1061/(ASCE)IS.1943-555X.0000550 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: wsl
- No DOI given, and none found for title: REWARDS - Robuste Entwicklung des Energiesystems z...
- No DOI given, and none found for title: CORDEX: Coordinated Regional Climate Downscaling E...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
editorialbot commented 2 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=2.10 s (28.1 files/s, 545123.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              9              0              0        1139862
JSON                            18              1              0           2302
Python                          22            421            405           1476
YAML                             4             46            102            272
TeX                              1             41              1            223
XML                              1             24              0            123
Markdown                         2             28              0             99
Bourne Shell                     2              6              6             16
-------------------------------------------------------------------------------
SUM:                            59            567            514        1144373
-------------------------------------------------------------------------------

Commit count by author:

   188  plagalq1
    95  Leonie Plaga
     5  David Huckebrink
     1  Leonie Sara Plaga
     1  velagb8k
editorialbot commented 2 months ago

Paper file info:

📄 Wordcount for paper.md is 1230

✅ The paper includes a Statement of need section

editorialbot commented 2 months ago

License info:

🔴 Failed to discover a valid open source license

editorialbot commented 2 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 2 months ago

Five most similar historical JOSS papers:

TopoPyScale: A Python Package for Hillslope Climate Downscaling Submitting author: @arcticsnow Handling editor: @hugoledoux (Active) Reviewers: @dvalters, @arbennett Similarity score: 0.7127

MetSim: A Python package for estimation and disaggregation of meteorological data Submitting author: @arbennett Handling editor: @sjpfenninger (Retired) Reviewers: @Chilipp, @dsryberg Similarity score: 0.7063

CLOVER: A modelling framework for sustainable community-scale energy systems Submitting author: @phil-sandwell Handling editor: @fraukewiese (Active) Reviewers: @EwaGomez, @fneum Similarity score: 0.6893

autumn: A Python library for dynamic modelling of captured CO_2 cost potential curves Submitting author: @Eugenio2192 Handling editor: @timtroendle (Retired) Reviewers: @igarizio, @milicag Similarity score: 0.6856

helios: An R package to process heating and cooling degrees for GCAM Submitting author: @mengqi-z Handling editor: @hugoledoux (Active) Reviewers: @RBhupi, @ibarraespinosa Similarity score: 0.6833

⚠️ 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 commented 2 months ago

Hi @Schneewittchen7001 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.

Schneewittchen7001 commented 2 months ago

Hello,

thanks for all the information. I would suggest the following reviewers: phil-sandwell arbennett koldunovn ciara-donegan FlorianK13

editorialbot commented 2 months ago

Hello @Schneewittchen7001, 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

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

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

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

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

# 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
Schneewittchen7001 commented 2 months ago

License info:

🔴 Failed to discover a valid open source license

I licensed my work with the gnu general public license, version 3. I am not sure why it is not recognized, if it something I did wrong, I would be happy to fix it.

kthyng commented 1 month ago

@Schneewittchen7001 Sorry for my delay. I think the license can’t be automatically detected because it isn’t called LICENSE. The name LICENSE is preferable because it conventionally applies to the whole project unless specified otherwise, versus a license file in the repo (which could be one of several and might apply to only one file or to many). This project appears to use a copyright notice in every source file so it's not ambiguous, though it is an extra step. Note that dual-licensed projects will often have multiple files, e.g., LICENSE-MIT and LICENSE-Apache , so even by best practices, there may not be a file named LICENSE. So, it could be simpler to go with a single LICENSE file to apply to the whole project, unless that isn't your intention.

kthyng commented 1 month ago

paper:

Schneewittchen7001 commented 1 month ago

@editorialbot generate pdf

Schneewittchen7001 commented 1 month ago

@editorialbot check repository

editorialbot commented 1 month ago

Software report:

github.com/AlDanial/cloc v 1.90  T=2.06 s (28.2 files/s, 555967.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              9              0              0        1139862
JSON                            18              1              0           2302
Python                          21            411            388           1511
YAML                             4             46            102            270
TeX                              1             41              1            233
XML                              1             24              0            123
Markdown                         2             27              0            100
Bourne Shell                     2              6              6             16
-------------------------------------------------------------------------------
SUM:                            58            556            497        1144417
-------------------------------------------------------------------------------

Commit count by author:

   202  plagalq1
    95  Leonie Plaga
     5  David Huckebrink
     1  Leonie Sara Plaga
     1  velagb8k
editorialbot commented 1 month ago

Paper file info:

📄 Wordcount for paper.md is 1058

✅ The paper includes a Statement of need section

editorialbot commented 1 month ago

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

editorialbot commented 1 month ago

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

editorialbot commented 1 month ago

Five most similar historical JOSS papers:

helios: An R package to process heating and cooling degrees for GCAM Submitting author: @mengqi-z Handling editor: @hugoledoux (Active) Reviewers: @RBhupi, @ibarraespinosa Similarity score: 0.7508

osiris: An R package to process climate impacts on agricultural yields for the Global Change Analysis Model Submitting author: @hahsan1 Handling editor: @martinfleis (Active) Reviewers: @jsun, @kauedesousa Similarity score: 0.7167

OpenSCM Two Layer Model: A Python implementation of the two-layer climate model Submitting author: @znicholls Handling editor: @leouieda (Retired) Reviewers: @sadielbartholomew, @ashiklom Similarity score: 0.7143

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

autumn: A Python library for dynamic modelling of captured CO_2 cost potential curves Submitting author: @Eugenio2192 Handling editor: @timtroendle (Retired) Reviewers: @igarizio, @milicag Similarity score: 0.7032

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

Schneewittchen7001 commented 1 month ago

@editorialbot check repository

Schneewittchen7001 commented 1 month ago

@editorialbot generate pdf

editorialbot commented 1 month ago

Software report:

github.com/AlDanial/cloc v 1.90  T=2.09 s (27.8 files/s, 548630.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              9              0              0        1139862
JSON                            18              1              0           2302
Python                          21            411            388           1511
YAML                             4             46            102            270
TeX                              1             41              1            233
XML                              1             24              0            123
Markdown                         2             27              0             98
Bourne Shell                     2              6              6             16
-------------------------------------------------------------------------------
SUM:                            58            556            497        1144415
-------------------------------------------------------------------------------

Commit count by author:

   203  plagalq1
    95  Leonie Plaga
     5  David Huckebrink
     1  Leonie Sara Plaga
     1  velagb8k
editorialbot commented 1 month ago

Paper file info:

📄 Wordcount for paper.md is 1006

✅ The paper includes a Statement of need section

editorialbot commented 1 month ago

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

editorialbot commented 1 month ago

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

editorialbot commented 1 month ago

Five most similar historical JOSS papers:

The Spreadsheet Energy System Model Generator (SESMG): A tool for the optimization of urban energy systems Submitting author: @chrklemm Handling editor: @timtroendle (Retired) Reviewers: @nick-gorman, @willu47 Similarity score: 0.7485

helios: An R package to process heating and cooling degrees for GCAM Submitting author: @mengqi-z Handling editor: @hugoledoux (Active) Reviewers: @RBhupi, @ibarraespinosa Similarity score: 0.7460

elmada: Dynamic electricity carbon emission factors and prices for Europe Submitting author: @mfleschutz Handling editor: @fraukewiese (Active) Reviewers: @nmstreethran, @olejandro Similarity score: 0.7307

Calliope: a multi-scale energy systems modelling framework Submitting author: @sjpfenninger Handling editor: @jedbrown (Active) Reviewers: @mdoucet, @gonsie, @ecotillasanchez Similarity score: 0.7288

autumn: A Python library for dynamic modelling of captured CO_2 cost potential curves Submitting author: @Eugenio2192 Handling editor: @timtroendle (Retired) Reviewers: @igarizio, @milicag Similarity score: 0.7271

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

Schneewittchen7001 commented 1 month ago

@Schneewittchen7001 Sorry for my delay. I think the license can’t be automatically detected because it isn’t called LICENSE. The name LICENSE is preferable because it conventionally applies to the whole project unless specified otherwise, versus a license file in the repo (which could be one of several and might apply to only one file or to many). This project appears to use a copyright notice in every source file so it's not ambiguous, though it is an extra step. Note that dual-licensed projects will often have multiple files, e.g., LICENSE-MIT and LICENSE-Apache , so even by best practices, there may not be a file named LICENSE. So, it could be simpler to go with a single LICENSE file to apply to the whole project, unless that isn't your intention.

@kthyng Thank you for your work. I have changed the license file name, shortened the paper (to 1006 words, I hope, that is ok) and added more information on our affiliations.

kthyng commented 1 month ago

Thank you @Schneewittchen7001! We have a backlog of submissions so I will add this to our waitlist. Thanks for your patience.

kthyng commented 1 month ago

@editorialbot invite @AdamRJensen as editor

editorialbot commented 1 month ago

Invitation to edit this submission sent!

kthyng commented 1 month ago

@AdamRJensen can you edit this submission?

AdamRJensen commented 1 month ago

@editorialbot assign @AdamRJensen as editor

editorialbot commented 1 month ago

Assigned! @AdamRJensen is now the editor

AdamRJensen commented 1 month ago

:wave: @phil-sandwell & @arbennett, 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

AdamRJensen commented 4 weeks ago

@kthyng can you remove the waitlist tag on this submission? Thanks 🙏

kthyng commented 4 weeks ago

Got it! You should have permission to do so, for future reference. If you can't, check in on the dev channel.

AdamRJensen commented 3 weeks ago

👋 @koldunovn & @ciara-donegan, 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

ciara-donegan commented 3 weeks ago

Hi @AdamRJensen, I would be happy to review!

koldunovn commented 3 weeks ago

Sorry, as @kthyng already knows, I tend to be a bit very slow with my reviews, and this isn't exactly my area of expertise. If I may suggest, I think @hcbloomfield19 would be an ideal candidate.

AdamRJensen commented 3 weeks ago

@editorialbot add @ciara-donegan as reviewer

Wonderful 🥳

editorialbot commented 3 weeks ago

@ciara-donegan added to the reviewers list!

AdamRJensen commented 3 weeks ago

👋 @hcbloomfield19 any interest in reviewing this JOSS submission?

AdamRJensen commented 2 weeks ago

@Schneewittchen7001 could you suggest some additional reviewers (please list their GH usernames but without the @ symbol).

@hcbloomfield19 we'd still very much appreciate it if you have time to review this JOSS submission? 😄

AdamRJensen commented 1 week ago

@Schneewittchen7001 could you please suggest some additional reviewers (preferably but commenting with their GH user names in this thread, but without the @ symbol to avoid tagging them just yet).

Schneewittchen7001 commented 12 hours ago

@AdamRJensen Sorry for my late reply. I would suggest the following reviewers: mengqi-z Zeitsperre nmstreethran sevberg