search

openjournals / joss-reviews

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

[REVIEW]: PowerAPI: A toolkit for estimating power consumption of software #6670

Closed editorialbot closed 3 months ago

editorialbot commented 5 months ago

Submitting author: !--author-handle-->@roda82<!--end-author-handle-- (Daniel Romero Acero) Repository: https://github.com/powerapi-ng/powerapi Branch with paper.md (empty if default branch): joss-paper Version: v2.7.0 Editor: !--editor-->@danielskatz<!--end-editor-- Reviewers: @varshaprasad96, @EpicStep Archive: 10.5281/zenodo.11453194

Status

status

Status badge code:

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

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

@varshaprasad96 & @EpicStep, 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 @danielskatz 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 @EpicStep

📝 Checklist for @varshaprasad96

editorialbot commented 5 months 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 5 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1109/CCGrid49817.2020.00-45 is OK
- 10.1109/ccgrid51090.2021.00042 is OK
- 10.1016/j.jss.2018.07.001 is OK
- 10.1109/ccgrid.2017.27 is OK
- 10.1109/SBAC-PAD.2015.26 is OK

MISSING DOIs

- No DOI given, and none found for title: Hardware Performance Counters (HwPC) Sensor
- No DOI given, and none found for title: PowerAPI Core
- No DOI given, and none found for title: SmartWatts Formula
- No DOI given, and none found for title: Scikit-learn: Machine learning in Python
- No DOI given, and none found for title: Intel 64 and IA-32 Architectures Software Develope...
- No DOI given, and none found for title: A universal modular ACTOR formalism for artificial...
- No DOI given, and none found for title: Actors: a model of concurrent computation in distr...

INVALID DOIs

- None
editorialbot commented 5 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.18 s (1124.4 files/s, 130127.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         127           3659           7217           8602
JSON                            37              8              0           2640
YAML                             6             49              0            282
reStructuredText                12            157             71            203
Markdown                         5             75              0            200
TeX                              1             11              0            133
TOML                             1             13              3             60
CSV                             10              0              0             41
DOS Batch                        1              8              1             26
make                             1              4              6              9
Dockerfile                       1              3              0              7
Bourne Shell                     1              1              0              5
-------------------------------------------------------------------------------
SUM:                           203           3988           7298          12208
-------------------------------------------------------------------------------

Commit count by author:

   295  Guillaume Fieni
   249  Arthur d'Azémar
   215  daniel
   192  Jordan Bouchoucha
   191  adazemar
   104  dependabot[bot]
    49  Kayoku
    48  Lauric Desauw
     8  Romain Rouvoy
     6  Pierre Rust
     4  altor
     2  Jordan
     2  PierreRustOrange
     1  Benjamin DANGLOT
     1  Dimitri Saingre
     1  Lars Schellhas
     1  TomeMD
     1  root
editorialbot commented 5 months ago

Paper file info:

📄 Wordcount for paper.md is 937

✅ The paper includes a Statement of need section

editorialbot commented 5 months ago

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

editorialbot commented 5 months ago

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

danielskatz commented 5 months ago

👋 @varshaprasad96 and @EpicStep - Thanks for agreeing to review this submission. This is the review thread for the paper. All of our communications will happen here from now on.

As you can see above, you each should use the command @editorialbot generate my checklist to create your review checklist. @editorialbot commands need to be the first thing in a new comment.

As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#6670 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if either of you require some more time. We can also use editorialbot (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@danielskatz) if you have any questions/concerns.

EpicStep commented 4 months ago

Review checklist for @EpicStep

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

varshaprasad96 commented 4 months ago

Review checklist for @varshaprasad96

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

EpicStep commented 4 months ago

@roda82 it is possible to mark 'master' as default instead of 'gh-pages' branch at https://github.com/powerapi-ng/powerapi-ng.github.io? Or add some description that there is a 'master' branch and it is necessary to contribute into it?

EpicStep commented 4 months ago

@roda82 I see docs/ directory in https://github.com/powerapi-ng/powerapi. It seemed outdated to me. Should we remove it?

roda82 commented 4 months ago

@roda82 it is possible to mark 'master' as default instead of 'gh-pages' branch at https://github.com/powerapi-ng/powerapi-ng.github.io? Or add some description that there is a 'master' branch and it is necessary to contribute into it?

Thank you for your feedback. I just marked master as default. However, we are not really waiting for contributions on the repository related to the website.

roda82 commented 4 months ago

@roda82 I see docs/ directory in https://github.com/powerapi-ng/powerapi. It seemed outdated to me. Should we remove it?

I just removed some unnecessary files. We cannot remove docs as it is used by sphinx to generate the API documentation by using docstring.

danielskatz commented 4 months ago

👋 @varshaprasad96 and @EpicStep - thanks for the nice progress so far - let me know if anything is blocking you from continuing (other than open issues & discussions with the author)

EpicStep commented 4 months ago

@danielskatz hi. I've completed the review. @roda82 thank you for the work you've done. 🎉

danielskatz commented 4 months ago

👋 @varshaprasad96 it looks like @roda82 has addressed your two open issues. Can these now be closed? Do they let you continue your review?

Thanks!

varshaprasad96 commented 4 months ago

Thanks @roda82 for addressing the reviews. @danielskatz I've completed the view!

danielskatz commented 4 months ago

Thanks @varshaprasad96 and @EpicStep!

danielskatz commented 4 months ago

@roda82 - I'll next proofread the paper, and let you know about what the next steps are

danielskatz commented 4 months ago

@editorialbot generate pdf

danielskatz commented 4 months ago

@editorialbot check references

editorialbot commented 4 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1109/CCGrid49817.2020.00-45 is OK
- 10.1109/ccgrid51090.2021.00042 is OK
- 10.1016/j.jss.2018.07.001 is OK
- 10.1109/ccgrid.2017.27 is OK
- 10.1109/SBAC-PAD.2015.26 is OK

MISSING DOIs

- No DOI given, and none found for title: Hardware Performance Counters (HwPC) Sensor
- No DOI given, and none found for title: PowerAPI Core
- No DOI given, and none found for title: SmartWatts Formula
- No DOI given, and none found for title: Scikit-learn: Machine learning in Python
- No DOI given, and none found for title: Intel 64 and IA-32 Architectures Software Develope...
- No DOI given, and none found for title: A universal modular ACTOR formalism for artificial...
- No DOI given, and none found for title: Actors: a model of concurrent computation in distr...

INVALID DOIs

- None
editorialbot commented 4 months ago

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

danielskatz commented 4 months ago

@roda82 - I've proofread the paper, and suggest changes in the paper/bib in https://github.com/powerapi-ng/powerapi/pull/341. Please merge this, or let me know what you disagree with, then we can continue the acceptance process.

roda82 commented 4 months ago

@danielskatz Thank you for the proofreading. I just merged your changes!

danielskatz commented 4 months ago

@editorialbot generate pdf

danielskatz commented 4 months ago

@roda - please proofread this version, and make sure everything looks ok to you. Once it does, please:

I can then move forward with accepting the submission.

editorialbot commented 4 months ago

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

danielskatz commented 3 months ago

👋 @roda82 - note that we're close to done, and just need a few more things from you, as above. (And I apologize for somehow tagging the wrong person there, so you may not have seen this.)

roda82 commented 3 months ago

@editorialbot set 10.5281/zenodo.11453194 as archive

editorialbot commented 3 months ago

I'm sorry @roda82, I'm afraid I can't do that. That's something only editors are allowed to do.

roda82 commented 3 months ago

@editorialbot set v2.7.0 as version

editorialbot commented 3 months ago

I'm sorry @roda82, I'm afraid I can't do that. That's something only editors are allowed to do.

danielskatz commented 3 months ago

@editorialbot set 10.5281/zenodo.11453194 as archive

editorialbot commented 3 months ago

Done! archive is now 10.5281/zenodo.11453194

danielskatz commented 3 months ago

@editorialbot set v2.7.0 as version

editorialbot commented 3 months ago

Done! version is now v2.7.0

danielskatz commented 3 months ago

@editorialbot recommend-accept

editorialbot commented 3 months ago 
Attempting dry run of processing paper acceptance...
roda82 commented 3 months ago

@danielskatz Thank you for the feedback. I just did what you asked me to do. The DOI is 10.5281/zenodo.11453194 and the PowerAPI version 2.7.0. I tried to update them without success. Authors' ORCID are already added. Please notice that it is also required to change the article title to PowerAPI: A Python framework for building software-defined power meters.

editorialbot commented 3 months ago

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

editorialbot commented 3 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1109/CCGrid49817.2020.00-45 is OK
- 10.1109/ccgrid51090.2021.00042 is OK
- 10.1016/j.jss.2018.07.001 is OK
- 10.1109/ccgrid.2017.27 is OK
- 10.1109/SBAC-PAD.2015.26 is OK

MISSING DOIs

- No DOI given, and none found for title: Hardware Performance Counters (HwPC) Sensor
- No DOI given, and none found for title: PowerAPI Core
- No DOI given, and none found for title: SmartWatts Formula
- No DOI given, and none found for title: Scikit-learn: Machine learning in Python
- No DOI given, and none found for title: Intel 64 and IA-32 Architectures Software Develope...
- Errored finding suggestions for "A universal modular ACTOR formalism for artificial...", please try later
- No DOI given, and none found for title: Actors: a model of concurrent computation in distr...

INVALID DOIs

- None
danielskatz commented 3 months ago

@roda82 - sorry, I see one more change needed - please merge https://github.com/powerapi-ng/powerapi/pull/347

Also, please confirm that the proof is fine, other than these case issues in a bib entry.

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

roda82 commented 3 months ago

@danielskatz The proof is fine. Thank you for your help!

danielskatz 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: Fieni given-names: Guillaume orcid: "https://orcid.org/0000-0002-0165-6824" - family-names: Acero given-names: Daniel Romero orcid: "https://orcid.org/0000-0002-5317-2610" - family-names: Rust given-names: Pierre orcid: "https://orcid.org/0000-0002-2761-4702" - family-names: Rouvoy given-names: Romain orcid: "https://orcid.org/0000-0003-1771-8791" doi: 10.5281/zenodo.11453194 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Fieni given-names: Guillaume orcid: "https://orcid.org/0000-0002-0165-6824" - family-names: Acero given-names: Daniel Romero orcid: "https://orcid.org/0000-0002-5317-2610" - family-names: Rust given-names: Pierre orcid: "https://orcid.org/0000-0002-2761-4702" - family-names: Rouvoy given-names: Romain orcid: "https://orcid.org/0000-0003-1771-8791" date-published: 2024-06-04 doi: 10.21105/joss.06670 issn: 2475-9066 issue: 98 journal: Journal of Open Source Software publisher: name: Open Journals start: 6670 title: "PowerAPI: A Python framework for building software-defined power meters" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06670" volume: 9 title: "PowerAPI: A Python framework for building software-defined power meters" ```

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 3 months ago

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