search

openjournals / joss-reviews

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

[REVIEW]: open-mastr: A Python Package to Download and Process the German Energy Registry Marktstammdatenregister #6758

Closed editorialbot closed 3 months ago

editorialbot commented 6 months ago

Submitting author: !--author-handle-->@FlorianK13<!--end-author-handle-- (Florian Kotthoff) Repository: https://github.com/OpenEnergyPlatform/open-MaStR Branch with paper.md (empty if default branch): feature-462-paper-joss Version: v0.14.4 Editor: !--editor-->@ppxasjsm<!--end-editor-- Reviewers: @rafmudaf, @cpschau Archive: 10.5281/zenodo.11516669

Status

status

Status badge code:

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

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@rafmudaf & @cpschau, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @ppxasjsm know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @cpschau

📝 Checklist for @rafmudaf

editorialbot commented 6 months ago

Hello humans, 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 6 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=1.90 s (65.4 files/s, 944078.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             8              4              0          22321
Python                          45           1546           2018           6900
XML                              1              0              1           1927
Markdown                        19            446              0           1682
Jupyter Notebook                11              0        1746837           1664
SQL                             14            474            668           1591
SVG                              2             59              0           1050
CSV                              8              0              0            906
YAML                            11             32              8            293
reStructuredText                 2             98            106             84
TeX                              1              7              0             75
CSS                              1              1              0              6
Dockerfile                       1              4              0              3
-------------------------------------------------------------------------------
SUM:                           124           2671        1749638          38502
-------------------------------------------------------------------------------

Commit count by author:

   456  Florian Kotthoff
   420  Guido Pleßmann
   303  Ludee
   160  chrwm
   135  Deniz Tepe
    79  Bachibouzouk
    67  solar-c
    57  cwm
    22  Ludwig Hülk
    14  jadeaffenjaeger
    13  Grazvy
     9  Benjamin W. Portner
     9  nesnoj
     7  Jonas Hoersch
     5  oakca
     3  Christian Hofmann
     3  Oskar.Oetken
     2  izzet kilicarslan
     2  stap-m
     1  BHLenjamin.portner
     1  FlorianK13
     1  Leonhard Markert
     1  steull
editorialbot commented 6 months ago

Paper file info:

📄 Wordcount for paper.md is 1088

✅ The paper includes a Statement of need section

editorialbot commented 6 months ago

License info:

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

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

OK DOIs

- 10.21105/joss.00884 is OK
- 10.5281/zenodo.5677623 is OK
- 10.5281/zenodo.7387843 is OK

MISSING DOIs

- No DOI given, and none found for title: Marktstammdatenregister
- No DOI given, and none found for title: Improving Data Reliability in Germany’s Energy Sys...
- 10.1016/j.apenergy.2018.11.097 may be a valid DOI for title: Open Power System Data–Frictionless data for elect...
- No DOI given, and none found for title: Open Energy Family - Open Energy Platform (OEP)
- No DOI given, and none found for title: A global database of power plants

INVALID DOIs

- None
editorialbot commented 6 months ago

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

ppxasjsm commented 6 months ago

@cpschau and @rafmudaf thank you so much for agreeing to review this submission. If you have any questions about the process please just message me on this thread by tagging me.

ppxasjsm commented 6 months ago

@FlorianK13 could you double check the missing DOIs in your references please? There seems to be at least one suggested that seems valid.

cpschau commented 6 months ago

Review checklist for @cpschau

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

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

OK DOIs

- 10.48550/arXiv.2304.10581 is OK
- 10.21105/joss.00884 is OK
- 10.1016/j.apenergy.2018.11.097 is OK
- 10.5281/zenodo.5677623 is OK
- 10.5281/zenodo.7387843 is OK

MISSING DOIs

- No DOI given, and none found for title: Marktstammdatenregister
- No DOI given, and none found for title: Open Energy Family - Open Energy Platform (OEP)
- No DOI given, and none found for title: A global database of power plants

INVALID DOIs

- None
editorialbot commented 6 months ago

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

FlorianK13 commented 6 months ago

@FlorianK13 could you double check the missing DOIs in your references please? There seems to be at least one suggested that seems valid.

@ppxasjsm I have added the missing DOI and rerun the editorialbot commands to generate the DOI report and the new paper version.

cpschau commented 6 months ago

@FlorianK13 the example for exporting data in the "Getting Started" section appears to contain a small mistake. The first line should likely be tables=["wind", "grids"] instead of tables=["wind", "grid"] (https://open-mastr.readthedocs.io/en/latest/getting_started/#exporting-data).

Additionally, while the documentation provides an extensive explanation of the data model, the "Getting Started" section could be enhanced with an example that lists all available tables in the database e.g. df = pd.read_sql_query("SELECT name FROM sqlite_master WHERE type='table';", con=db.engine).

FlorianK13 commented 6 months ago

Thanks for your comment @cpschau Could you copy this to a new issue in the open-mastr repository? Then I can refer to it when fixing the things that you mention.

If it helps, you can see one example issue that I have created for another JOSS Review.

rafmudaf commented 6 months ago

Review checklist for @rafmudaf

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

ppxasjsm commented 6 months ago

@rafmudaf and @cpschau, it looks like you have both completed your review checklist. Have all your concerns been addressed? There is still an open issue for @FlorianK13 to address from @rafmudaf? Once you are happy with everything can you please let me know here?

FlorianK13 commented 6 months ago

First of all, thanks to @rafmudaf and @cpschau for reviewing open-mastr 👍

All changes from the two Reviews are now merged on our develop branch. We need to make a new release so that those changes actually appear on our doc page. Since every Release takes some time and effort, I first want to make sure that @cpschau and @rafmudaf have finished their review? Maybe you can indicate it with a thumbs up on this comment?

If the review is finished, we can start the release procedure for open-mastr.

ppxasjsm commented 6 months ago

Ok great!

@editorialbot create post-review checklist

ppxasjsm commented 6 months ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance

ppxasjsm commented 6 months ago

@FlorianK13 can you make a tagged release and archive, and report the version number and archive DOI here please?

FlorianK13 commented 6 months ago

The release is started and tracked in https://github.com/OpenEnergyPlatform/open-MaStR/issues/530

cpschau commented 6 months ago

@rafmudaf and @cpschau, it looks like you have both completed your review checklist. Have all your concerns been addressed? There is still an open issue for @FlorianK13 to address from @rafmudaf? Once you are happy with everything can you please let me know here?

Sorry for the late reply! I was absent for the last week. Besides the minor improvements to the documentation already made by @FlorianK13, I did not find any additional issues with the tool. However, I plan to spend a few more hours this week testing the API download method.

FlorianK13 commented 6 months ago

@rafmudaf and @cpschau, it looks like you have both completed your review checklist. Have all your concerns been addressed? There is still an open issue for @FlorianK13 to address from @rafmudaf? Once you are happy with everything can you please let me know here?

Sorry for the late reply! I was absent for the last week. Besides the minor improvements to the documentation already made by @FlorianK13, I did not find any additional issues with the tool. However, I plan to spend a few more hours this week testing the API download method.

Allright, then we pause the release for now and wait for your review @cpschau 👍

cpschau commented 6 months ago

@rafmudaf and @cpschau, it looks like you have both completed your review checklist. Have all your concerns been addressed? There is still an open issue for @FlorianK13 to address from @rafmudaf? Once you are happy with everything can you please let me know here?

Sorry for the late reply! I was absent for the last week. Besides the minor improvements to the documentation already made by @FlorianK13, I did not find any additional issues with the tool. However, I plan to spend a few more hours this week testing the API download method.

Allright, then we pause the release for now and wait for your review @cpschau 👍

I just had a little play with the API download method as well as the MaStRAPI class using some of the functions referenced here. Everything seems to be functional. I only faced issues once I used the deprecated class open_mastr.soap_api.download.MaStRDownload, which is addressed in https://github.com/OpenEnergyPlatform/open-MaStR/issues/487.

Once the broken links in the documentation are fixed (https://github.com/OpenEnergyPlatform/open-MaStR/issues/532), I will be happy, and you can proceed with the new release.

FlorianK13 commented 5 months ago

The new issue from @cpschau is fixed and will be part of the release. If everything works, we do our release tomorrow.

cpschau commented 5 months ago

Great! Then my review is finished as well, @ppxasjsm.

FlorianK13 commented 5 months ago

@ppxasjsm The release tag is v0.14.4, on zenodo it should appear as https://doi.org/10.5281/zenodo.11516669 as soon as it was reviewed by the zenodo Open Energy Family Group. This Review will hopefully take place this evening.

FlorianK13 commented 5 months ago

@ppxasjsm Are the release on github and zenodo everything you need from us, or is there anything else?

FlorianK13 commented 4 months ago

Hi @ppxasjsm, I wanted to check if you need anything else from us?

ppxasjsm commented 3 months ago

Hi @FlorianK13, my apologies I am now processing the publication. I was on holidays and had a massive backlog of work.

ppxasjsm commented 3 months ago

@editorialbot generate pdf

editorialbot commented 3 months ago

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

ppxasjsm commented 3 months ago

@editorialbot check references

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

✅ OK DOIs

- 10.48550/arXiv.2304.10581 is OK
- 10.21105/joss.00884 is OK
- 10.1016/j.apenergy.2018.11.097 is OK
- 10.5281/zenodo.5677623 is OK
- 10.5281/zenodo.7387843 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Marktstammdatenregister
- No DOI given, and none found for title: Open Energy Family - Open Energy Platform (OEP)
- No DOI given, and none found for title: A global database of power plants

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
ppxasjsm commented 3 months ago

@editorialbot set 10.5281/zenodo.11516669 as archive

editorialbot commented 3 months ago

Done! archive is now 10.5281/zenodo.11516669

ppxasjsm commented 3 months ago

@editorialbot set v0.14.4 as version

editorialbot commented 3 months ago

Done! version is now v0.14.4

ppxasjsm commented 3 months ago

@editorialbot generate pdf

editorialbot commented 3 months ago

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

ppxasjsm commented 3 months ago

@editorialbot recommend-accept

editorialbot commented 3 months ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 3 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.48550/arXiv.2304.10581 is OK
- 10.21105/joss.00884 is OK
- 10.1016/j.apenergy.2018.11.097 is OK
- 10.5281/zenodo.5677623 is OK
- 10.5281/zenodo.7387843 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Marktstammdatenregister
- No DOI given, and none found for title: Open Energy Family - Open Energy Platform (OEP)
- No DOI given, and none found for title: A global database of power plants

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
editorialbot commented 3 months ago

:wave: @openjournals/pe-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5819, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

kyleniemeyer commented 3 months ago

This looks good to me.

kyleniemeyer commented 3 months ago

@editorialbot accept

editorialbot commented 3 months ago 
Doing it live! Attempting automated processing of paper acceptance...
editorialbot commented 3 months ago

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Kotthoff given-names: Florian orcid: "https://orcid.org/0000-0003-3666-6122" - family-names: Muschner given-names: Christoph orcid: "https://orcid.org/0000-0001-8144-5260" - family-names: Tepe given-names: Deniz orcid: "https://orcid.org/0000-0002-7605-0173" - family-names: Pleßmann given-names: Guido orcid: "https://orcid.org/0000-0002-4176-9946" - family-names: Hülk given-names: Ludwig orcid: "https://orcid.org/0000-0003-4655-2321" contact: - family-names: Kotthoff given-names: Florian orcid: "https://orcid.org/0000-0003-3666-6122" doi: 10.5281/zenodo.11516669 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Kotthoff given-names: Florian orcid: "https://orcid.org/0000-0003-3666-6122" - family-names: Muschner given-names: Christoph orcid: "https://orcid.org/0000-0001-8144-5260" - family-names: Tepe given-names: Deniz orcid: "https://orcid.org/0000-0002-7605-0173" - family-names: Pleßmann given-names: Guido orcid: "https://orcid.org/0000-0002-4176-9946" - family-names: Hülk given-names: Ludwig orcid: "https://orcid.org/0000-0003-4655-2321" date-published: 2024-08-27 doi: 10.21105/joss.06758 issn: 2475-9066 issue: 100 journal: Journal of Open Source Software publisher: name: Open Journals start: 6758 title: "open-mastr: A Python Package to Download and Process the German Energy Registry Marktstammdatenregister" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06758" volume: 9 title: "open-mastr: A Python Package to Download and Process the German Energy Registry Marktstammdatenregister" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

editorialbot commented 3 months ago

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

editorialbot commented 3 months ago

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/5826
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06758
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...