editorialbot commented 6 months ago

Submitting author: !--author-handle-->@FLomb@AdamRJensen<!--end-editor-- Reviewers: @FabianHofmann, @trevorb1 Archive: 10.5281/zenodo.11526597

Status

Status badge code:

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

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

@noah80 & @FabianHofmann, 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 @AdamRJensen 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 @noah80

📝 Checklist for @FabianHofmann

📝 Checklist for @trevorb1

Bachibouzouk commented 3 months ago

Points 1 and 2 still need to be addressed, work in progress here :)

Those points have been addressed now in https://github.com/RAMP-project/RAMP/pull/145

@AdamRJensen, we now addressed all comments from @FabianHofmann and @trevorb in the branch joss-paper :)

I guess we now need to wait that they approve our changes before we proceed further, right?

Bachibouzouk 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:

AdamRJensen commented 3 months ago

Yes the next step is for @FabianHofmann and @trevorb to complete their checklists

FabianHofmann commented 3 months ago

Great! looks good, thank you for being so responsive :) I have completed the checklist, and the paper is good to go from my side :)

AdamRJensen commented 3 months ago

@editorialbot remove @noah80 from reviewers

editorialbot commented 3 months ago

@noah80 removed from the reviewers list!

AdamRJensen commented 3 months ago

@trevorb just missing a single tick mark from your side

trevorb1 commented 3 months ago

Everything looks great on my side! @AdamRJensen I now have completed my checklist. Well done to all the authors!

Bachibouzouk 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:

Bachibouzouk 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:

AdamRJensen commented 3 months ago

A few editorial comments and questions:

[x] Is RAMP an acronym?
[x] Suggestions in https://github.com/RAMP-project/RAMP/pull/148

FLomb commented 3 months ago

A few editorial comments and questions:

* [ ]  Is RAMP an acronym?

* [ ]  Suggestions in [Editorial suggested changes to JOSS paper RAMP-project/RAMP#148](https://github.com/RAMP-project/RAMP/pull/148)

Thanks for the suggestions, @AdamRJensen. They look good, so I will approve the PR shortly.

Regarding whether RAMP is an acronym, it used to be, but it's not anymore. When we first developed it, the name was a (loose) acronym for 'Remote-Areas Multi-energy load Profiles'. However, since the range of applications has, in the meantime, gone way beyond only remote areas, we stopped referring to the original acronym in our material (website, docs, publications) and just kept the name. In fact, the name RAMP, per se, makes intuitive sense in the context of energy system load profile simulation, as 'ramp up' and 'ramp down' are commonly used terms to refer to sudden changes in the load.

Bachibouzouk commented 3 months ago

@AdamRJensen - your suggestions are now merged into joss-paper

AdamRJensen commented 3 months ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Double check authors and affiliations (including ORCIDs)
Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
Archive the release on Zenodo/figshare/etc and post the DOI here.
Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

[x] Read the text of the paper and offer comments/corrections (as either a list or a pull request)
[x] Check that the archive title, author list, version tag, and the license are correct
[x] Set archive DOI with @editorialbot set <DOI here> as archive
[x] Set version with @editorialbot set <version here> as version
[x] Double check rendering of paper with @editorialbot generate pdf
[x] Specifically check the references with @editorialbot check references and ask author(s) to update as needed
[x] Recommend acceptance with @editorialbot recommend-accept

AdamRJensen commented 3 months ago

@Bachibouzouk, @FLomb will you make a new release of the package and upload to Zenodo (then write back here with the version number and doi)?

Bachibouzouk 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:

Bachibouzouk commented 3 months ago

@AdamRJensen

We facing a (small) dilemma. There have been a few pull requests merged into development in the meantime. We have now two options:

1) make the release from joss-paper branch and then make another release later on with the content of those pull requests

2) merge joss-paper into development and make the release from there

The 4 PRs do not represent a lot of code changes and most of them even add more tests. https://github.com/RAMP-project/RAMP/pull/116/files (a change in 2 lines of code) https://github.com/RAMP-project/RAMP/pull/117/files (only changes to workflow files to publish to pypi) https://github.com/RAMP-project/RAMP/pull/111/files (in this one the code is adapted to add the option to set an appliance in productive use mode) https://github.com/RAMP-project/RAMP/pull/132/files (a change in one line of code)

In our opinion those are mainly bugfixes and therefore the joss publication could only benefit from those. Although it might raise the problem on your side that the reviewers would need to review those extra changes and it might be a time burden. We thought we still ask you if you are ok that we go for choice 2). If not we just implement choice 1) :)

AdamRJensen commented 3 months ago

I think it's perfectly fine to include these recent PRs in the release that is reference in the JOSS publication

AdamRJensen commented 3 months ago

@Bachibouzouk, @FLomb Just wanted to make sure that you known that the next step is for you to make a new release of the package and upload to Zenodo (maybe you've already done that), and then write back here with the version number and doi.

Bachibouzouk commented 3 months ago

@Bachibouzouk, @FLomb Just wanted to make sure that you known that the next step is for you to make a new release of the package and upload to Zenodo (maybe you've already done that), and then write back here with the version number and doi.

@AdamRJensen - we are on it since monday, but we have encountered a few release bugs (new version of matplotlib which doesn't contain a function we were using, tests not running locally, etc..) which delayed the process. We should be able to release today though :)

FLomb commented 3 months ago

@AdamRJensen, we have completed the new release of the package and its upload to Zenodo. The version is 'v0.5.2' and the Zenodo DOI is the following: 10.5281/zenodo.11526597.

AdamRJensen commented 3 months ago

@editorialbot set 10.5281/zenodo.11526597 as archive

editorialbot commented 3 months ago

Done! archive is now 10.5281/zenodo.11526597

AdamRJensen commented 3 months ago

@editorialbot set 0.5.2 as version

editorialbot commented 3 months ago

Done! version is now 0.5.2

AdamRJensen commented 3 months ago

@editorialbot generate pdf

AdamRJensen 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.1016/j.esr.2023.101171 is OK
- 10.1016/j.esd.2023.05.004 is OK
- 10.1016/j.enconman.2023.117223 is OK
- 10.1016/j.segan.2023.101043 is OK
- 10.1016/j.segy.2022.100088 is OK
- 10.1016/j.apenergy.2022.118676 is OK
- 10.1016/j.esd.2021.10.009 is OK
- 10.1016/j.esd.2020.07.002 is OK
- 10.1016/j.energy.2019.04.097 is OK
- 10.1016/j.segan.2023.101120 is OK
- 10.1016/j.joule.2022.05.009 is OK
- 10.3390/app10217445 is OK
- 10.5281/zenodo.10275752 is OK
- 10.17028/rd.lboro.2001129.v8 is OK
- 10.1186/s42162-021-00180-6 is OK
- 10.21105/joss.03574 is OK

MISSING DOIs

- No DOI given, and none found for title: RAMP: stochastic multi-energy demand profiles
- 10.24251/hicss.2023.097 may be a valid DOI for title: Sustainable Energy System Planning in Developing C...

INVALID DOIs

- https://doi.org/10.1016/j.esd.2016.01.005 is INVALID because of 'https://doi.org/' prefix

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:

AdamRJensen commented 3 months ago

MISSING DOIs

No DOI given, and none found for title: RAMP: stochastic multi-energy demand profiles

10.24251/hicss.2023.097 may be a valid DOI for title: Sustainable Energy System Planning in Developing C...

INVALID DOIs https://doi.org/10.1016/j.esd.2016.01.005 is INVALID because of 'https://doi.org/' prefix

@FLomb could you fix these? Also, I think instead of citing the github repo then just put the link in a parentheses.

FLomb commented 3 months ago

@FLomb could you fix these? Also, I think instead of citing the github repo then just put the link in a parentheses.

@AdamRJensen I'm sorry about the missing/invalid DOIs. We had checked them, but these issues must have slipped through. How to best fix them? Should we make a new minor release with the corrected paper?

AdamRJensen commented 3 months ago

@AdamRJensen I'm sorry about the missing/invalid DOIs. We had checked them, but these issues must have slipped through. How to best fix them? Should we make a new minor release with the corrected paper?

I don't see any need to make a new release, but if you could just make the changes to the branch with the paper. The version and doi are only for the code part and not the paper part as far as I understand.

FLomb commented 3 months ago

@AdamRJensen Thanks for the clarification. I have fixed the DOI issues in the joss-paper branch.

AdamRJensen 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:

AdamRJensen 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.1016/j.esr.2023.101171 is OK
- 10.1016/j.esd.2023.05.004 is OK
- 10.1016/j.enconman.2023.117223 is OK
- 10.1016/j.segan.2023.101043 is OK
- 10.1016/j.segy.2022.100088 is OK
- 10.1016/j.apenergy.2022.118676 is OK
- 10.1016/j.esd.2021.10.009 is OK
- 10.1016/j.esd.2020.07.002 is OK
- 10.1016/j.energy.2019.04.097 is OK
- 10.1016/j.segan.2023.101120 is OK
- 10.1016/j.joule.2022.05.009 is OK
- 10.3390/app10217445 is OK
- 10.24251/hicss.2023.097 is OK
- 10.5281/zenodo.10275752 is OK
- 10.17028/rd.lboro.2001129.v8 is OK
- 10.1016/j.esd.2016.01.005 is OK
- 10.1186/s42162-021-00180-6 is OK
- 10.21105/joss.03574 is OK

MISSING DOIs

- None

INVALID DOIs

- None

AdamRJensen 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.1016/j.esr.2023.101171 is OK
- 10.1016/j.esd.2023.05.004 is OK
- 10.1016/j.enconman.2023.117223 is OK
- 10.1016/j.segan.2023.101043 is OK
- 10.1016/j.segy.2022.100088 is OK
- 10.1016/j.apenergy.2022.118676 is OK
- 10.1016/j.esd.2021.10.009 is OK
- 10.1016/j.esd.2020.07.002 is OK
- 10.1016/j.energy.2019.04.097 is OK
- 10.1016/j.segan.2023.101120 is OK
- 10.1016/j.joule.2022.05.009 is OK
- 10.3390/app10217445 is OK
- 10.24251/hicss.2023.097 is OK
- 10.5281/zenodo.10275752 is OK
- 10.17028/rd.lboro.2001129.v8 is OK
- 10.1016/j.esd.2016.01.005 is OK
- 10.1186/s42162-021-00180-6 is OK
- 10.21105/joss.03574 is OK

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/5485, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

kyleniemeyer commented 3 months ago

Hi @FLomb, it looks like one of your coauthors (Sergio Balderrama) is missing from the Zenodo author/contributor list. Can you correct that? You can edit the Zenodo archive metadata without needing a new version/DOI.

FLomb commented 3 months ago

Hi @FLomb, it looks like one of your coauthors (Sergio Balderrama) is missing from the Zenodo author/contributor list. Can you correct that? You can edit the Zenodo archive metadata without needing a new version/DOI.

Hi @kyleniemeyer, thank you for spotting it; that was quite a mistake! Sergio Balderrama has now been added to the Zenodo author list.

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: Lombardi given-names: Francesco orcid: "https://orcid.org/0000-0002-7624-5886" - family-names: Duc given-names: Pierre-François orcid: "https://orcid.org/0000-0001-8698-8854" - family-names: Tahavori given-names: Mohammad Amin orcid: "https://orcid.org/0000-0002-7753-0523" - family-names: Sanchez-Solis given-names: Claudia orcid: "https://orcid.org/0000-0003-2385-7392" - family-names: Eckhoff given-names: Sarah orcid: "https://orcid.org/0000-0002-6168-4835" - family-names: Hart given-names: Maria C. G. orcid: "https://orcid.org/0000-0002-1031-9782" - family-names: Sanvito given-names: Francesco orcid: "https://orcid.org/0000-0002-9152-9684" - family-names: Ireland given-names: Gregory - family-names: Balderrama given-names: Sergio - family-names: Kraft given-names: Johann - family-names: Dhungel given-names: Gokarna - family-names: Quoilin given-names: Sylvain contact: - family-names: Lombardi given-names: Francesco orcid: "https://orcid.org/0000-0002-7624-5886" doi: 10.5281/zenodo.11526597 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Lombardi given-names: Francesco orcid: "https://orcid.org/0000-0002-7624-5886" - family-names: Duc given-names: Pierre-François orcid: "https://orcid.org/0000-0001-8698-8854" - family-names: Tahavori given-names: Mohammad Amin orcid: "https://orcid.org/0000-0002-7753-0523" - family-names: Sanchez-Solis given-names: Claudia orcid: "https://orcid.org/0000-0003-2385-7392" - family-names: Eckhoff given-names: Sarah orcid: "https://orcid.org/0000-0002-6168-4835" - family-names: Hart given-names: Maria C. G. orcid: "https://orcid.org/0000-0002-1031-9782" - family-names: Sanvito given-names: Francesco orcid: "https://orcid.org/0000-0002-9152-9684" - family-names: Ireland given-names: Gregory - family-names: Balderrama given-names: Sergio - family-names: Kraft given-names: Johann - family-names: Dhungel given-names: Gokarna - family-names: Quoilin given-names: Sylvain date-published: 2024-06-12 doi: 10.21105/joss.06418 issn: 2475-9066 issue: 98 journal: Journal of Open Source Software publisher: name: Open Journals start: 6418 title: "RAMP: stochastic simulation of user-driven energy demand time series" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06418" volume: 9 title: "RAMP: stochastic simulation of user-driven energy demand time series" ```

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.

openjournals / joss-reviews

[REVIEW]: RAMP: stochastic simulation of user-driven energy demand time series #6418

Status

Reviewer instructions & questions

Checklists

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance