search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
696 stars 36 forks source link

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

Closed editorialbot closed 10 months ago

editorialbot commented 1 year ago

Submitting author: !--author-handle-->@rchaput<!--end-author-handle-- (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: !--editor-->@ajstewartlang<!--end-editor-- Reviewers: @seba-1511, @louiseadennis Archive: 10.5281/zenodo.8239411

Status

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

editorialbot commented 1 year ago

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 commented 1 year ago 
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 commented 1 year ago

Wordcount for paper.md is 1172

editorialbot commented 1 year ago 
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 commented 1 year ago

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

louiseadennis commented 1 year ago

Review checklist for @louiseadennis

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

louiseadennis commented 11 months ago

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 commented 11 months ago

Many thanks for your review @louiseadennis

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

seba-1511 commented 11 months ago

Review checklist for @seba-1511

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

seba-1511 commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

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

seba-1511 commented 11 months ago

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 commented 11 months ago

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 commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

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

ajstewartlang commented 11 months ago

@editorialbot check references

editorialbot commented 11 months ago 
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 commented 11 months ago

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

rchaput commented 11 months ago

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 commented 11 months ago

@editorialbot generate pdf

editorialbot commented 11 months ago

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

ajstewartlang commented 11 months ago

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:

rchaput commented 11 months ago

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 commented 11 months ago

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

editorialbot commented 11 months ago

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

ajstewartlang commented 11 months ago

@editorialbot set 10.5281/zenodo.8239411 as archive

editorialbot commented 11 months ago

Done! archive is now 10.5281/zenodo.8239411

ajstewartlang commented 11 months ago

@editorialbot recommend-accept

editorialbot commented 11 months ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 11 months ago 
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 commented 11 months ago

:warning: Error preparing paper acceptance. The generated XML metadata file is invalid. 

IDREFS attribute rid references an unknown ID "Open-to-extensions"
ajstewartlang commented 11 months ago

@openjournals/dev can you help?

danielskatz commented 11 months ago

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 commented 11 months ago

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

rchaput commented 11 months ago

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 commented 11 months ago

@editorialbot recommend-accept

editorialbot commented 11 months ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 11 months ago 
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 commented 11 months ago

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

gkthiruvathukal commented 10 months ago

@editorialbot accept

editorialbot commented 10 months ago 
Doing it live! Attempting automated processing of paper acceptance...
editorialbot commented 10 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: 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 commented 10 months ago

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

editorialbot commented 10 months ago

🚨🚨🚨 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 :point_right: https://github.com/openjournals/joss-papers/pull/4510
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05410
  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 commented 10 months ago

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

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:

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:

rchaput commented 10 months ago

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.