[REVIEW]: Ethical Smart Grid: a Gym environment for learning ethical behaviours #5410

editorialbot · 2023-04-25T16:57:57Z

Submitting author: @rchaput (Rémy Chaput)
Repository: https://github.com/ethicsai/ethical-smart-grid
Branch with paper.md (empty if default branch): paper
Version: v1.1.0-joss-paper
Editor: @ajstewartlang
Reviewers: @seba-1511, @louiseadennis
Archive: 10.5281/zenodo.8239411

Status

Status badge code:

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

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

@seba-1511 & @louiseadennis, 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 @ajstewartlang 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 @louiseadennis

📝 Checklist for @seba-1511

The text was updated successfully, but these errors were encountered:

editorialbot · 2023-04-25T16:57:59Z

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 · 2023-04-25T16:58:00Z

Software report:

github.com/AlDanial/cloc v 1.88  T=0.06 s (1309.1 files/s, 119223.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          58           1024           2336           1902
reStructuredText                13            368            696            535
Markdown                         4             73              0            208
TeX                              1             10              0            104
YAML                             3             15             31             88
TOML                             1              5              5             69
JSON                             1              0              0             30
DOS Batch                        1              8              1             26
make                             1              5              9             11
-------------------------------------------------------------------------------
SUM:                            83           1508           3078           2973
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

editorialbot · 2023-04-25T16:58:02Z

Wordcount for paper.md is 1172

editorialbot · 2023-04-25T16:58:07Z

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

OK DOIs

- 10.1109/JPROC.2018.2840045 is OK
- 10.1016/j.rser.2019.05.005 is OK
- 10.3390/su10082703 is OK
- 10.1016/j.suscom.2022.100726 is OK
- 10.1016/j.apenergy.2018.03.123 is OK
- 10.1109/EMS.2009.53 is OK

MISSING DOIs

- None

INVALID DOIs

- None

editorialbot · 2023-04-25T16:59:46Z

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

louiseadennis · 2023-06-16T09:51:57Z

Review checklist for @louiseadennis

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/ethicsai/ethical-smart-grid?
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 (@rchaput) 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?

louiseadennis · 2023-07-24T16:05:16Z

I'm happy to recommend Accept for this submission to JOSS.

I've left recommendations for some improvements to documentation as an issue, but believe that the submission is meets the JOSS criteria as it stands.

ajstewartlang · 2023-07-25T10:18:23Z

Many thanks for your review @louiseadennis

👋 @seba-1511 could you let me know how your review is going please?

seba-1511 · 2023-07-31T01:07:27Z

Review checklist for @seba-1511

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/ethicsai/ethical-smart-grid?
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 (@rchaput) 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?

seba-1511 · 2023-07-31T01:13:14Z

@editorialbot generate pdf

editorialbot · 2023-07-31T01:14:57Z

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

seba-1511 · 2023-07-31T01:28:56Z

Hello @ajstewartlang,

I'm also happy to accept this submission. I only have one comment for the authors:

The example in your GitHub README doesn't run out-of-the-box because the algorithms module is not included in smartgrid. I suggest either adding it or mentioning you need to add the directory to your python path.

Best,

rchaput · 2023-08-04T08:48:31Z

Sorry for the delay, I have just added the algorithms module to the built package (published on PyPi) as suggested.

Thank you for your review!

Please tell me if there is anything else.

ajstewartlang · 2023-08-10T08:34:01Z

@editorialbot generate pdf

editorialbot · 2023-08-10T08:35:18Z

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

ajstewartlang · 2023-08-10T08:39:24Z

@editorialbot check references

editorialbot · 2023-08-10T08:39:34Z

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

OK DOIs

- 10.1109/JPROC.2018.2840045 is OK
- 10.1016/j.rser.2019.05.005 is OK
- 10.3390/su10082703 is OK
- 10.1016/j.suscom.2022.100726 is OK
- 10.1016/j.apenergy.2018.03.123 is OK
- 10.1109/EMS.2009.53 is OK

MISSING DOIs

- None

INVALID DOIs

- None

ajstewartlang · 2023-08-10T09:31:13Z

@rchaput Thanks for addressing the comments - I think we're almost there. In the paper, could you update the OpenAI gym citation to please?

Brockman, G., Cheung, V., Pettersson, L., Schneider, J., Schulman, J., Tang, J., & Zaremba, W. (2016). Openai gym. ArXiv Preprint ArXiv:1606.01540.

The reference for OpenAI Gym was missing the mention "arXiv preprint", as per openjournals/joss-reviews#5410

rchaput · 2023-08-11T13:05:09Z

Thank you for the review! I have updated the Gym citation.

For reference, I originally used the "official" citation from Gym's GitHub repository:

@misc{1606.01540,
  Author = {Greg Brockman and Vicki Cheung and Ludwig Pettersson and Jonas Schneider and John Schulman and Jie Tang and Wojciech Zaremba},
  Title = {OpenAI Gym},
  Year = {2016},
  Eprint = {arXiv:1606.01540},
}

(which is more or less the same as the ArXiv citation), but it seems that the JOSS style does not show that it is a pre-print.
Instead, the reference from Google Scholar does the job (but making it look like an article, and ArXiv a journal).

ajstewartlang · 2023-08-11T13:06:22Z

@editorialbot generate pdf

ajstewartlang · 2023-08-11T13:11:02Z

Many thanks for your helpful reviews @seba-1511 and @louiseadennis - and for this great submission @rchaput - we're almost there.

@rchaput if you could now do the following please, that would be great:

Make a tagged release of the software.
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.

rchaput · 2023-08-11T14:35:52Z

I have created a new tagged release and archived it on Zenodo, here is the DOI:

10.5281/zenodo.8239411

I have updated the metadata on Zenodo to make sure the title and authors correspond.

ajstewartlang · 2023-08-11T16:14:09Z

@editorialbot set v1.1.0-joss-paper as version

editorialbot · 2023-08-11T16:14:11Z

Done! version is now v1.1.0-joss-paper

ajstewartlang · 2023-08-11T16:14:55Z

@editorialbot set 10.5281/zenodo.8239411 as archive

editorialbot · 2023-08-11T16:14:57Z

Done! archive is now 10.5281/zenodo.8239411

ajstewartlang · 2023-08-11T16:15:21Z

@editorialbot recommend-accept

editorialbot · 2023-08-11T16:15:22Z

Attempting dry run of processing paper acceptance...

editorialbot · 2023-08-11T16:15:27Z

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

OK DOIs

- 10.1109/JPROC.2018.2840045 is OK
- 10.1016/j.rser.2019.05.005 is OK
- 10.3390/su10082703 is OK
- 10.1016/j.suscom.2022.100726 is OK
- 10.1016/j.apenergy.2018.03.123 is OK
- 10.1109/EMS.2009.53 is OK

MISSING DOIs

- None

INVALID DOIs

- None

editorialbot · 2023-08-11T16:17:04Z

⚠️ Error preparing paper acceptance. The generated XML metadata file is invalid.

IDREFS attribute rid references an unknown ID "Open-to-extensions"

ajstewartlang · 2023-08-11T16:20:12Z

@openjournals/dev can you help?

danielskatz · 2023-08-11T16:23:35Z

See the paper's reference to this in
Several components can be extended, and new scenarios can be implemented (see [Open to extensions](#Open-to-extensions)).
This references a label that doesn't exist, I think

ajstewartlang · 2023-08-11T16:36:49Z

@rchaput could you add the appropriate label in the paper please (or remove reference to it)?

The link to "Open to extensions" did not work, because the label was not found, as per openjournals/joss-reviews#5410 Added an explicit label to the corresponding header.

rchaput · 2023-08-11T17:59:52Z

Oops, sorry about that! I thought that labels would be automatically created for each header. I have added the label, I hope that it will work now (the link works when building locally).
Please do not hesitate to tell me if there is another problem.

ajstewartlang · 2023-08-11T18:14:16Z

@editorialbot recommend-accept

editorialbot · 2023-08-11T18:14:18Z

Attempting dry run of processing paper acceptance...

editorialbot · 2023-08-11T18:14:23Z

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

OK DOIs

- 10.1109/JPROC.2018.2840045 is OK
- 10.1016/j.rser.2019.05.005 is OK
- 10.3390/su10082703 is OK
- 10.1016/j.suscom.2022.100726 is OK
- 10.1016/j.apenergy.2018.03.123 is OK
- 10.1109/EMS.2009.53 is OK

MISSING DOIs

- None

INVALID DOIs

- None

editorialbot · 2023-08-11T18:16:11Z

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

gkthiruvathukal · 2023-08-25T03:08:35Z

@editorialbot accept

editorialbot · 2023-08-25T03:08:37Z

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

editorialbot · 2023-08-25T03:10:19Z

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: Scheirlinck
  given-names: Clément
- family-names: Chaput
  given-names: Rémy
  orcid: "https://orcid.org/0000-0002-2233-7566"
- family-names: Hassas
  given-names: Salima
contact:
- family-names: Chaput
  given-names: Rémy
  orcid: "https://orcid.org/0000-0002-2233-7566"
doi: 10.5281/zenodo.8239411
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Scheirlinck
    given-names: Clément
  - family-names: Chaput
    given-names: Rémy
    orcid: "https://orcid.org/0000-0002-2233-7566"
  - family-names: Hassas
    given-names: Salima
  date-published: 2023-08-25
  doi: 10.21105/joss.05410
  issn: 2475-9066
  issue: 88
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5410
  title: "Ethical Smart Grid: a Gym environment for learning ethical
    behaviours"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05410"
  volume: 8
title: "Ethical Smart Grid: a Gym environment for learning ethical
  behaviours"

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 · 2023-08-25T03:10:23Z

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

editorialbot · 2023-08-25T03:10:24Z

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

Here's what you must now do:

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

Any issues? Notify your editorial technical team...

editorialbot · 2023-08-25T03:10:39Z

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

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

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

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

rchaput · 2023-08-25T06:50:45Z

Thank you for accepting our paper! I very much appreciated the JOSS editorial and reviewing process, it was great to receive frequent feedback. Many thanks again to the reviewers for their work.

editorialbot added Python review TeX Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning labels Apr 25, 2023

editorialbot assigned ajstewartlang Apr 25, 2023

editorialbot mentioned this issue Apr 25, 2023

[PRE REVIEW]: Ethical Smart Grid: a Gym environment for learning ethical behaviours #5370

Closed

louiseadennis mentioned this issue Jun 26, 2023

Issue executing Quick Usage Instructions ethicsai/ethical-smart-grid#1

Open

This was referenced Jul 18, 2023

Community Guidelines ethicsai/ethical-smart-grid#2

Closed

Clarity of Documentation (Some Suggestions) ethicsai/ethical-smart-grid#3

Closed

rchaput added a commit to ethicsai/ethical-smart-grid that referenced this issue Aug 11, 2023

Fixed reference in paper

49efbad

The reference for OpenAI Gym was missing the mention "arXiv preprint", as per openjournals/joss-reviews#5410

editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Aug 11, 2023

editorialbot added accepted published Papers published in JOSS labels Aug 25, 2023

gkthiruvathukal closed this as completed Aug 25, 2023

[REVIEW]: Ethical Smart Grid: a Gym environment for learning ethical behaviours #5410

[REVIEW]: Ethical Smart Grid: a Gym environment for learning ethical behaviours #5410

Comments

editorialbot commented Apr 25, 2023 • edited

Status

Reviewer instructions & questions

Checklists

editorialbot commented Apr 25, 2023

editorialbot commented Apr 25, 2023

editorialbot commented Apr 25, 2023

editorialbot commented Apr 25, 2023

editorialbot commented Apr 25, 2023

louiseadennis commented Jun 16, 2023 • edited

Review checklist for @louiseadennis

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

louiseadennis commented Jul 24, 2023

ajstewartlang commented Jul 25, 2023

seba-1511 commented Jul 31, 2023 • edited

Review checklist for @seba-1511

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

seba-1511 commented Jul 31, 2023

editorialbot commented Jul 31, 2023

seba-1511 commented Jul 31, 2023

rchaput commented Aug 4, 2023

ajstewartlang commented Aug 10, 2023

editorialbot commented Aug 10, 2023

ajstewartlang commented Aug 10, 2023

editorialbot commented Aug 10, 2023

ajstewartlang commented Aug 10, 2023

rchaput commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

rchaput commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

editorialbot commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

editorialbot commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

editorialbot commented Aug 11, 2023

editorialbot commented Aug 11, 2023

editorialbot commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

danielskatz commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

rchaput commented Aug 11, 2023

ajstewartlang commented Aug 11, 2023

editorialbot commented Aug 11, 2023

editorialbot commented Aug 11, 2023

editorialbot commented Aug 11, 2023

gkthiruvathukal commented Aug 25, 2023

editorialbot commented Aug 25, 2023

editorialbot commented Aug 25, 2023

editorialbot commented Aug 25, 2023

editorialbot commented Aug 25, 2023

editorialbot commented Aug 25, 2023

rchaput commented Aug 25, 2023

editorialbot commented Apr 25, 2023 •

edited

louiseadennis commented Jun 16, 2023 •

edited

seba-1511 commented Jul 31, 2023 •

edited