Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REVIEW]: RHEIA: Robust design optimization of renewable Hydrogen and dErIved energy cArrier systems #4370

Closed
editorialbot opened this issue May 4, 2022 · 45 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented May 4, 2022

Submitting author: @DCoppitters (Diederik Coppitters)
Repository: https://github.com/rheia-framework/RHEIA
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: @fraukewiese
Reviewers: @andr1976, @ClaraBuettner
Archive: 10.5281/zenodo.6782705

Status

status

Status badge code:

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

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

@andr1976 & @ClaraBuettner, 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 @fraukewiese 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 @andr1976

📝 Checklist for @ClaraBuettner

@editorialbot
Copy link
Collaborator Author

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
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.17 s (319.9 files/s, 130240.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
SVG                              6              6              6           7477
Python                          27           1806           3246           3206
TeX                              2            293              0           2623
reStructuredText                15            999           1141           1363
Markdown                         2             29              0            124
DOS Batch                        1              8              1             26
TOML                             1              1              0             17
make                             1              4              6              9
-------------------------------------------------------------------------------
SUM:                            55           3146           4400          14845
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.energy.2020.118798 is OK
- 10.1016/j.fuel.2020.117049 is OK
- 10.1115/1.4044491 is OK
- 10.1016/j.energy.2021.120692 is OK
- 10.1016/j.egypro.2019.01.549 is OK
- 10.1016/j.apenergy.2019.04.101 is OK
- 10.1016/j.apenergy.2017.03.132 is OK
- 10.3390/app10196653 is OK
- 10.1007/s11831-017-9240-5 is OK
- 10.2514/6.2017-3827 is OK
- 10.3390/en14134027 is OK
- 10.1016/j.jcp.2016.12.015 is OK
- 10.21105/joss.00884 is OK
- 10.21105/joss.00676 is OK
- 10.1061/9780784413609.257 is OK
- 10.1016/j.jocs.2015.08.008 is OK
- 10.21105/joss.00825 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1043

@editorialbot
Copy link
Collaborator Author

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

@andr1976
Copy link

andr1976 commented May 9, 2022

Review checklist for @andr1976

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

General checks

  • Repository: Is the source code for this software available at the https://github.com/rheia-framework/RHEIA?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@DCoppitters) 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

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 and who the target audience is?
  • 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?

@andr1976
Copy link

@fraukewiese I have started the review, and 9 days ago I filed an issue and a pull request, but I am not getting any response from the author DCoppitters. Can you contact him with a friendly reminder, just to make sure that the review can proceed

@ClaraBuettner
Copy link

ClaraBuettner commented May 19, 2022

Review checklist for @ClaraBuettner

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

General checks

  • Repository: Is the source code for this software available at the https://github.com/rheia-framework/RHEIA?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@DCoppitters) 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

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 and who the target audience is?
  • 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?

@fraukewiese
Copy link

@DCoppitters : Have you seen the issue and pull request from @andr1976 regarding the review process?

@DCoppitters
Copy link

@fraukewiese : I have seen the issues and pull request. My apologies for not getting back to the reviewers sooner.

@fraukewiese
Copy link

@andr1976 Thanks for your review so far! Have your comments been adequately answered/handled?

@andr1976
Copy link

andr1976 commented Jun 14, 2022 via email

@fraukewiese
Copy link

@andr1976 Thanks for your review, would you recommend this submission for publication?

@fraukewiese
Copy link

@ClaraBuettner : Thank you for your review so far. As the checklist is complete: Do you have any comments/suggestions/questions to the author? Would you recommend this submission for publication in its present form or is there anything that should be revised?

@andr1976
Copy link

@fraukewiese yes indeed

@ClaraBuettner
Copy link

@ClaraBuettner : Thank you for your review so far. As the checklist is complete: Do you have any comments/suggestions/questions to the author? Would you recommend this submission for publication in its present form or is there anything that should be revised?

No, I don't have any other comments or questions.
I would recommend this submission for publication in its present form.

@fraukewiese
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.energy.2020.118798 is OK
- 10.1016/j.fuel.2020.117049 is OK
- 10.1115/1.4044491 is OK
- 10.1016/j.energy.2021.120692 is OK
- 10.1016/j.egypro.2019.01.549 is OK
- 10.1016/j.apenergy.2019.04.101 is OK
- 10.1016/j.apenergy.2017.03.132 is OK
- 10.3390/app10196653 is OK
- 10.1007/s11831-017-9240-5 is OK
- 10.2514/6.2017-3827 is OK
- 10.3390/en14134027 is OK
- 10.1016/j.jcp.2016.12.015 is OK
- 10.21105/joss.00884 is OK
- 10.21105/joss.00676 is OK
- 10.1061/9780784413609.257 is OK
- 10.1016/j.jocs.2015.08.008 is OK
- 10.21105/joss.00825 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@fraukewiese
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@fraukewiese
Copy link

@andr1976 and @ClaraBuettner: Thank you very much for your review!

@fraukewiese
Copy link

@DCoppitters : At this point could you:

  • Make a tagged release of your software, and list the version tag of the archived version here.
  • Archive the reviewed software in Zenodo or a similar service (e.g., figshare, an institutional repository)
  • Check the archival deposit (e.g., in Zenodo) has the correct metadata. This includes the title (should match the paper title) and author list (make sure the list is correct and people who only made a small fix are not on it). You may also add the authors' ORCID.
  • Please list the DOI of the archived version here.

I can then move forward with accepting the submission.

@DCoppitters
Copy link

@andr1976 and @ClaraBuettner : Thanks a lot for your review, time and efforts!

@fraukewiese : Below the required information:

  • v1.0.0
  • 10.5281/zenodo.6782705

Thanks a lot for your time and efforts!

@fraukewiese
Copy link

@editorialbot set v1.0.0 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v1.0.0

@fraukewiese
Copy link

@editorialbot set 10.5281/zenodo.6782705 as archive

@editorialbot
Copy link
Collaborator Author

Done! Archive is now 10.5281/zenodo.6782705

@fraukewiese
Copy link

@editorialbot set 10.5281/zenodo.6782705 as archive

@editorialbot
Copy link
Collaborator Author

Done! Archive is now 10.5281/zenodo.6782705

@fraukewiese
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.energy.2020.118798 is OK
- 10.1016/j.fuel.2020.117049 is OK
- 10.1115/1.4044491 is OK
- 10.1016/j.energy.2021.120692 is OK
- 10.1016/j.egypro.2019.01.549 is OK
- 10.1016/j.apenergy.2019.04.101 is OK
- 10.1016/j.apenergy.2017.03.132 is OK
- 10.3390/app10196653 is OK
- 10.1007/s11831-017-9240-5 is OK
- 10.2514/6.2017-3827 is OK
- 10.3390/en14134027 is OK
- 10.1016/j.jcp.2016.12.015 is OK
- 10.21105/joss.00884 is OK
- 10.21105/joss.00676 is OK
- 10.1061/9780784413609.257 is OK
- 10.1016/j.jocs.2015.08.008 is OK
- 10.21105/joss.00825 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#3327

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3327, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Jun 30, 2022
@danielskatz
Copy link

@DCoppitters - I'm the AEiC this week who will complete processing of this paper. I've suggested some small changes to the paper in rheia-framework/RHEIA#14 - please merge this or let me know what you disagree with, then we can proceed.

@DCoppitters
Copy link

@danielskatz : Thank you for improving the paper, I merged the pull request.

@danielskatz
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.energy.2020.118798 is OK
- 10.1016/j.fuel.2020.117049 is OK
- 10.1115/1.4044491 is OK
- 10.1016/j.energy.2021.120692 is OK
- 10.1016/j.egypro.2019.01.549 is OK
- 10.1016/j.apenergy.2019.04.101 is OK
- 10.1016/j.apenergy.2017.03.132 is OK
- 10.3390/app10196653 is OK
- 10.1007/s11831-017-9240-5 is OK
- 10.2514/6.2017-3827 is OK
- 10.3390/en14134027 is OK
- 10.1016/j.jcp.2016.12.015 is OK
- 10.21105/joss.00884 is OK
- 10.21105/joss.00676 is OK
- 10.1061/9780784413609.257 is OK
- 10.1016/j.jocs.2015.08.008 is OK
- 10.21105/joss.00825 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3337, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@danielskatz
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.04370 joss-papers#3338
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04370
  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...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Jul 5, 2022
@danielskatz
Copy link

Congratulations to @DCoppitters (Diederik Coppitters) and co-authors!!

And thanks to @andr1976 and @ClaraBuettner for reviewing and to @fraukewiese for editing!
We couldn't do this without you!

@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 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.04370/status.svg)](https://doi.org/10.21105/joss.04370)

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

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

This is how it will look in your documentation:

DOI

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Development

No branches or pull requests

6 participants