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

[editorialbot]

Submitting author: @AlexanderJuestel (Alexander Jüstel)
Repository: https://github.com/AlexanderJuestel/pyheatdemand
Branch with paper.md (empty if default branch):
Version: v0.1.3
Editor: @timtroendle
Reviewers: @nmstreethran, @samuelduchesne
Archive: 10.5281/zenodo.10779503

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)

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

@nmstreethran & @samuelduchesne, 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 @timtroendle 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 @nmstreethran

📝 Checklist for @samuelduchesne

[editorialbot]

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]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.09 s (518.3 files/s, 248993.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                           4            567            622           1253
Jupyter Notebook                15              4          17306            970
reStructuredText                 7            195             99            441
Markdown                        10            134              0            433
TeX                              1             21              0            200
YAML                             9             22             29            198
TOML                             1             10              6             69
-------------------------------------------------------------------------------
SUM:                            47            953          18062           3564
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

[editorialbot]

Wordcount for paper.md is 2087

[editorialbot]

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
- 10.1007/BF00288933 is OK

MISSING DOIs

- 10.20944/preprints202312.1795.v1 may be a valid DOI for title: Unveiling the spatial distribution of heat demand in North-West-Europe compiled with national heat Consumption data

INVALID DOIs

- None

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[AlexanderJuestel]

MISSING DOIs

- 10.20944/preprints202312.1795.v1 may be a valid DOI for title: Unveiling the spatial distribution of heat demand in North-West-Europe compiled with national heat Consumption data

10.20944/preprints202312.1795.v1 is the preprint version of the peer-reviewed article at 10.3390/en17020481 which was first-authored by me and applies the PyHeatDemand tool to create a transnational-harmonized heat demand map of the Interreg North-West-Europe Region

[nmstreethran]

Review checklist for @nmstreethran

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/AlexanderJuestel/pyhd?
• License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@AlexanderJuestel) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
• Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
• Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
• Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

[AlexanderJuestel]

FYI: I tried to update the API Reference and documentation today but RTD failed to build due to an error with Sphinx versions and dependencies. Will have to wait for a fix here. See also the issue reported here: sphinx-doc/sphinx#11890

https://readthedocs.org/projects/pyhd/builds/23253592/

[timtroendle]

@nmstreethran, @samuelduchesne, could you please give us a brief update about the status of your reviews?

[nmstreethran]

@timtroendle I just finished reviewing the documentation and installation instructions (see AlexanderJuestel/pyheatdemand#28). I'm still going through the paper and examples to verify the functionality. I expect to complete my review by the end of the week.

[samuelduchesne]

@timtroendle. Apologies, I won't be able to start the review before the end of the month, as I am travelling with little connectivity.

If this is an issue, I can abandon the review.

[timtroendle]

@samuelduchesne thanks for letting us know. Finishing your review by the beginning of March will be fine.

Safe travels!

[AlexanderJuestel]

@timtroendle I just finished reviewing the documentation and installation instructions (see AlexanderJuestel/pyheatdemand#28). I'm still going through the paper and examples to verify the functionality. I expect to complete my review by the end of the week.

@timtroendle I have implemented all the requested changes by @nmstreethran on this issue :)

[timtroendle]

@AlexanderJuestel, great! @nmstreethran could you please tick the boxes in your checklist if you are happy with these changes?

[nmstreethran]

Sorry, I was only halfway through my review. I've opened two more issues now and will complete my checklist once these are resolved.
AlexanderJuestel/pyheatdemand#29
AlexanderJuestel/pyheatdemand#30

[AlexanderJuestel]

Already working on the comments made by @nmstreethran and will continue tomorrow :)

[AlexanderJuestel]

@editorialbot generate pdf

[AlexanderJuestel]

Sorry, I was only halfway through my review. I've opened two more issues now and will complete my checklist once these are resolved. AlexanderJuestel/pyheatdemand#29 AlexanderJuestel/pyheatdemand#30

@timtroendle, @nmstreethran all comments and remarks in the two referenced issues should be addressed now

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[nmstreethran]

@AlexanderJuestel Thanks for addressing my comments! @timtroendle I've completed my review checklist.

Just a note that the repository URL should be updated from https://github.com/AlexanderJuestel/pyhd to https://github.com/AlexanderJuestel/pyheatdemand.

[timtroendle]

@editorialbot set https://github.com/AlexanderJuestel/pyheatdemand as repository

[AlexanderJuestel]

@timtroendle, the new version is v0.1.3, the archive is 10.5281/zenodo.10779503

Otherwise, all is fine from my side! Ready for publication

[kyleniemeyer]

@AlexanderJuestel you do not need to push a new version or make a new archive just for paper edits - only software changes

[AlexanderJuestel]

@kyleniemeyer sounds great!

[timtroendle]

Now that there is a new version, let's update here as well.

[timtroendle]

@editorialbot set 10.5281/zenodo.10779503 as archive

[editorialbot]

Done! archive is now 10.5281/zenodo.10779503

[timtroendle]

@editorialbot set v0.1.3 as version

[editorialbot]

Done! version is now v0.1.3

[kyleniemeyer]

Hi @AlexanderJuestel I made a few small edits, could you review and merge AlexanderJuestel/pyheatdemand#35 ?

[AlexanderJuestel]

@kyleniemeyer edits reviewed and merged!

[kyleniemeyer]

@editorialbot generate pdf

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[kyleniemeyer]

Hi @AlexanderJuestel, unfortunately my author change for the pandas citation accidentally included double curly brackets, so the author list appears incorrectly. This PR fixes it: AlexanderJuestel/pyheatdemand#36

[AlexanderJuestel]

@kyleniemeyer, merged it :)

[kyleniemeyer]

@editorialbot generate pdf

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[kyleniemeyer]

@editorialbot accept

[editorialbot]

Doing it live! Attempting automated processing of paper acceptance...

[editorialbot]

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: Jüstel
  given-names: Alexander
  orcid: "https://orcid.org/0000-0003-0980-7479"
- family-names: Strozyk
  given-names: Frank
  orcid: "https://orcid.org/0000-0002-3067-831X"
doi: 10.5281/zenodo.10779503
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Jüstel
    given-names: Alexander
    orcid: "https://orcid.org/0000-0003-0980-7479"
  - family-names: Strozyk
    given-names: Frank
    orcid: "https://orcid.org/0000-0002-3067-831X"
  date-published: 2024-03-06
  doi: 10.21105/joss.06275
  issn: 2475-9066
  issue: 95
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6275
  title: PyHeatDemand - Processing Tool for Heat Demand Data
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06275"
  volume: 9
title: PyHeatDemand - Processing Tool for Heat Demand Data

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]

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

[editorialbot]

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

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.06275 joss-papers#5098
1. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06275
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

[kyleniemeyer]

Congratulations @AlexanderJuestel on your article's publication in JOSS! Please consider signing up as a reviewer if you haven't already.

Many thanks to @nmstreethran and @samuelduchesne for reviewing this, and @timtroendle for editing.

[editorialbot]

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06275/status.svg)](https://doi.org/10.21105/joss.06275)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.06275">
  <img src="https://joss.theoj.org/papers/10.21105/joss.06275/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.06275/status.svg
   :target: https://doi.org/10.21105/joss.06275

This is how it will look in your documentation:

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://reviewers.joss.theoj.org/join
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

[AlexanderJuestel]

@kyleniemeyer @timtroendle thanks for managing the review! It was a pleasure publishing my third paper within the JOSS/JOSE universe! I am glad it went smoothly and I could learn something from the great reviews of @nmstreethran and @samuelduchesne!