[PRE REVIEW]: DistrictGenerator: Generating Building-Specific Load Profiles for Residential Districts

[editorialbot]

Submitting author: !--author-handle-->@JoelSchoelzel<!--end-author-handle-- (Joel Schoelzel) Repository: https://github.com/RWTH-EBC/districtgenerator Branch with paper.md (empty if default branch): JOSS_submission Version: v0.1.0 Editor: !--editor-->@adamrjensen<!--end-editor-- Reviewers: !--reviewers-list-->@jtock<!--end-reviewers-list-- Managing EiC: Kyle Niemeyer

Status

Status badge code:

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

Author instructions

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

@JoelSchoelzel 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]

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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.15 s (229.3 files/s, 31617.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          23            764           1504           1875
JSON                             5              0              0            270
Markdown                         5             60              0            203
TeX                              1             17              0            129
CSV                              1              0              0              3
-------------------------------------------------------------------------------
SUM:                            35            841           1504           2480
-------------------------------------------------------------------------------

Commit count by author:

     2  ISHINJaR
     2  Sarah
     1  Joel Schölzel

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1147

✅ The paper includes a Statement of need section

[editorialbot]

:warning: An error happened when generating the pdf.

[editorialbot]

License info:

🟡 License found: Other (Check here for OSI approval)

[kyleniemeyer]

Hi @JoelSchoelzel, unfortunately we do not have any editors available to handle your submission right now, so I have to put this on our waitlist. In the meantime, any reviewer recommendations you can make would be welcome (but please do not directly tag/invite anyone).

[kyleniemeyer]

@editorialbot invite @AdamRJensen as editor

Hi @AdamRJensen, would you be able to take this submission? It's been on the waitlist for about two months now. Thanks!

[editorialbot]

There was a problem inviting the user to edit this submission.

[kyleniemeyer]

@editorialbot invite @AdamRJensen as editor

[editorialbot]

There was a problem inviting the user to edit this submission.

[kyleniemeyer]

@openjournals/dev any ideas what is causing this error in the invite as editor command?

[AdamRJensen]

@kyleniemeyer There's hardly any documentation for this package (there's a readme file and some example .py files) which makes me question whether this should pass scope review.

There are also no continuous integration tests, the authors have made efforts to make the paper render, and there has only been a single release (no track record of development).

[AdamRJensen]

@openjournals/dev any ideas what is causing this error in the invite as editor command?

It's probably because of my case sensitive github username.

[JoelSchoelzel]

Dear all,

I apologise for the problems and the late reply. Unfortunately, I did not receive an email notification about this issue in July. If there is still the possibility, I will solve the described problems in the coming days! The DistrictGenerator was created in the first version as a finished tool from a research project and then published as an open source tool on github, which is why there is no track record of development. What did you mean by "the authors have made efforts to make the paper render"? We are still very interested in the submission and your review, as we hope that this will significantly improve the quality of our tool. We therefore hope for your patience.

Kind regards

[AdamRJensen]

⚠️ An error happened when generating the pdf.

@JoelSchoelzel the paper isn't rendering, most likely because you haven't formatted the paper correctly.

Also, is it correct that there's no separate documentation site for the package?

[kyleniemeyer]

@JoelSchoelzel I think the issue might be missing the --- after the YAML block at the top of the paper. If you add this below the bibliography line, that might fix the problem.

I also noticed that you have some authors with empty orcid fields. I'd suggest just removing those, if those coauthors do not have ORCIDs.

[JoelSchoelzel]

@AdamRJensen, @kyleniemeyer we have discussed your comments with our team. First of all, you are absolutely right that the documentation is not sufficient. There is currently no separate documentation page. Our idea is to build a detailed documentation page and improve the readme. Furthermore, we would like to revise the examples so that they can be used as end-to-end functional tests for the main functions of the DistrictGenerator.

As the DistrictGenerator is an important product of the German accompanying scientific research in the field of energy supply of neighbourhoods (https://www.energiewendebauen.de/en/research/accompanying_scientific_research) and has been published as an open webtool for science and practice actors (https://districtgenerator.eonerc.rwth-aachen.de/de/), we would like to ask for the possibility to improve and complete the mentioned points. With view on our project work, we will probably be able to do this by 16 October. We hope that this will still be possible during the pre-review phase.

[AdamRJensen]

@JoelSchoelzel This should be fine. Note, a separate documentation site using for example Sphinx and readthedocs is often preferred. That way you can also render the examples with some output plots.

I also don't see any testing, which is necessary to make sure that functions don't accidentally change over time.

[kyleniemeyer]

@JoelSchoelzel that timing should be fine—we will pause your submission until you've been able to make those changes. As @AdamRJensen said, testing is also required; you can see the full review criteria for JOSS here: https://joss.readthedocs.io/en/latest/review_criteria.html

[AdamRJensen]

@editorialbot assign @adamrjensen as editor

[editorialbot]

Assigned! @adamrjensen is now the editor

[JoelSchoelzel]

Hello @AdamRJensen, we have now added the following points: under docs you will find a Sphinx documentation (docs/build_/html/index to open it in the browser). We have also adapted the examples and added a test_examples.py for the functional testing of the examples and thus the main functions of the DistrictGenerator that the user can use. The bug in the paper has now also been fixed according to @kyleniemeyer advice. (https://github.com/RWTH-EBC/districtgenerator/tree/JOSS_submission) We hope that this fulfils all requirements. Let me know if there are any other inadequacies. Best regards Joel

[AdamRJensen]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf.

[JoelSchoelzel]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PyHeatDemand - Processing Tool for Heat Demand Data Submitting author: @AlexanderJuestel Handling editor: @timtroendle (Retired) Reviewers: @nmstreethran, @samuelduchesne Similarity score: 0.7519

RAMP: stochastic simulation of user-driven energy demand time series Submitting author: @FLomb Handling editor: @AdamRJensen (Active) Reviewers: @FabianHofmann, @trevorb1 Similarity score: 0.7366

CESAR-P: A dynamic urban building energy simulation tool Submitting author: @kristina-o Handling editor: @timtroendle (Retired) Reviewers: @olejandro, @noah80, @jasondegraw Similarity score: 0.7323

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.7131

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

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

[JoelSchoelzel]

@AdamRJensen now it really works^^

[AdamRJensen]

@JoelSchoelzel thanks for making progress!

Could you make a list of 3-5 potential reviewers and comment in this thread with their GH usernames (DO NOT add the @ symbol in front, to avoid tagging them just yet). Thanks.

[JoelSchoelzel]

@AdamRJensen

trevorb1 nmstreethran leijerry888 samuelduchesne

[AdamRJensen]

:wave: @samuelduchesne & @leijerry888, 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

[samuelduchesne]

@AdamRJensen Apologies, I don't have the bandwidth at the moment.

[AdamRJensen]

@JoelSchoelzel could you recommend some additional reviewers. The first two you suggested are already reviewing other JOSS articles.

[JoelSchoelzel]

@AdamRJensen

jtock GregorBecker ijbd kandersolar

[AdamRJensen]

:wave: @jtock& @ijbd, 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

[jtock]

@AdamRJensen that looks very interesting. You can join me to the list of the reviewers! I can start working on it from the beginning of December.

[AdamRJensen]

Wonderful, thank you @jtock

[AdamRJensen]

@editorialbot add @jtock as reviewer

[editorialbot]

@jtock added to the reviewers list!

[AdamRJensen]

@JoelSchoelzel could you recommend some additional reviewers

[JoelSchoelzel]

@AdamRJensen

lymereJ Haitham-ghaida eldemet jasondegraw