[REVIEW]: Nempy: A Python package for modelling the Australian National Electricity Market dispatch procedure

whedon commented 3 years ago

Submitting author: @nick-gorman (Nicholas Gorman) Repository: https://github.com/UNSW-CEEM/nempy Version: v1.1.2 Editor: @timtroendle Reviewer: @noah80, @robinroche Archive: 10.5281/zenodo.5989170

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

Status badge code:

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

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 & @robinroche, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

Make sure you're logged in to your GitHub account
Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @timtroendle 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 ✨

Review checklist for @noah80

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@nick-gorman) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] 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?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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?

Review checklist for @robinroche

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@nick-gorman) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] 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?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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?

timtroendle commented 2 years ago

@whedon generate pdf from branch joss-paper

whedon commented 2 years ago

Attempting PDF compilation from custom branch joss-paper. Reticulating splines etc...

whedon commented 2 years ago

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

timtroendle commented 2 years ago

@whedon check references from branch joss-paper

whedon commented 2 years ago

Attempting to check references... from custom branch joss-paper

whedon commented 2 years ago

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

OK DOIs

- 10.5281/zenodo.3509134 is OK
-  10.25080/Majora-92bf1922-00a  is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1016/j.rser.2018.08.002 is OK
- 10.1016/j.apenergy.2021.116731 is OK
- 10.1016/j.rser.2020.110195 is OK
- 10.1038/sdata.2018.203 is OK
- 10.1016/j.enpol.2013.01.052 is OK

MISSING DOIs

- None

INVALID DOIs

- None

timtroendle commented 2 years ago

@whedon set 10.5281/zenodo.5989170 as archive

whedon commented 2 years ago

OK. 10.5281/zenodo.5989170 is the archive.

timtroendle commented 2 years ago

@whedon set v1.1.2 as version

whedon commented 2 years ago

OK. v1.1.2 is the version.

timtroendle commented 2 years ago

Thanks @nick-gorman. It all looks good and I will now recommend your submission for acceptance.

timtroendle commented 2 years ago

@whedon recommend-accept

whedon commented 2 years ago

Attempting dry run of processing paper acceptance...

whedon commented 2 years ago

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

Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/2932

If the paper PDF and Crossref deposit XML look good in https://github.com/openjournals/joss-papers/pull/2932, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

whedon commented 2 years ago

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

OK DOIs

- 10.5281/zenodo.3509134 is OK
-  10.25080/Majora-92bf1922-00a  is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1016/j.rser.2018.08.002 is OK
- 10.1016/j.apenergy.2021.116731 is OK
- 10.1016/j.rser.2020.110195 is OK
- 10.1038/sdata.2018.203 is OK
- 10.1016/j.enpol.2013.01.052 is OK

MISSING DOIs

- None

INVALID DOIs

- None

kthyng commented 2 years ago

Hi @nick-gorman! Items for wrapping up:

I see your Zenodo archive and looks good, except there seems to be a "2" in the middle of your title?
Please check the capitalization in your references. For example, Grozev et al has "australia" uncapitalized. You can preserve capitalization by putting {} around characters or strings in your .bib file.

nick-gorman commented 2 years ago

Thanks @kthyng

Not sure how that 2 got there, or how I didn't see it. Good tip with the curly brackets.

These issues should be resolved.

kthyng commented 2 years ago

@whedon generate pdf

whedon commented 2 years ago

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

kthyng commented 2 years ago

@whedon generate pdf from branch joss-paper

whedon commented 2 years ago

Attempting PDF compilation from custom branch joss-paper. Reticulating splines etc...

whedon commented 2 years ago

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

kthyng commented 2 years ago

@nick-gorman ok everything looks good! But, do you want me to accept this submission from the joss-paper branch or were you going to merge it first? Either way is fine, I just need to know which.

nick-gorman commented 2 years ago

@kthyng I've just merged joss-paper into master, so should be good to go from master

kthyng commented 2 years ago

@whedon generate pdf

whedon commented 2 years ago

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

kthyng commented 2 years ago

@whedon accept deposit=true

whedon commented 2 years ago

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

whedon commented 2 years ago

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

whedon commented 2 years ago

🚨🚨🚨 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 :point_right: https://github.com/openjournals/joss-papers/pull/2938
Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03596
If everything looks good, then close this review issue.
Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

kthyng commented 2 years ago

Congratulations on your new publication @nick-gorman! Many thanks to editor @timtroendle and reviewers @noah80 and @robinroche for your time, hard work, and expertise!!

whedon commented 2 years 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.03596/status.svg)](https://doi.org/10.21105/joss.03596)

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

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

This is how it will look in your documentation:

We need your help!

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://joss.theoj.org/reviewer-signup.html
Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

nick-gorman commented 2 years ago

Thank you @noah80 @robinroche @timtroendle and @kthyng!

openjournals / joss-reviews