[PRE REVIEW]: NEMSEER: A Python package for downloading and handling historical National Electricity Market forecast data produced by the Australian Energy Market Operator

[editorialbot]

Submitting author: @prakaa (Abhijith Prakash)
Repository: https://github.com/UNSW-CEEM/NEMSEER
Branch with paper.md (empty if default branch): joss-paper
Version: v1.0.4
Editor: @arfon
Reviewers: @mfleschutz, @amandadsmith
Managing EiC: Kyle Niemeyer

Status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @prakaa. Currently, there isn't a JOSS editor assigned to your paper.

@prakaa if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, 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]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.36 s (179.3 files/s, 28495.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          17            495            856           2945
Jupyter Notebook                 3              0           1857           1310
Markdown                        17            377              0           1006
HTML                            19              0              0            722
YAML                             4             30             53            178
TeX                              1             18              0            163
TOML                             1             14             20             72
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            64            946           2794           6431
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

[editorialbot]

Wordcount for paper.md is 968

[editorialbot]

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

OK DOIs

- 10/gcj9vc is OK
- 10.5334/jors.148 is OK
- 10.5281/zenodo.7697295 is OK
- 10.5281/zenodo.7467074 is OK
- 10.1016/j.joule.2022.01.004 is OK
- 10.25080/Majora-92bf1922-00a is OK
- 10.5281/zenodo.3509134 is OK

MISSING DOIs

- 10.4337/9781788979955.00017 may be a valid DOI for title: The Evolution of the European Model for Electricity Markets

INVALID DOIs

- None

[editorialbot]

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

[kyleniemeyer]

@editorialbot query scope

[editorialbot]

Submission flagged for editorial review.

[kyleniemeyer]

Hello @prakaa, thanks for your submission to JOSS. The editorial board is going to take a closer look to see if this meets our scope for research software and substantial scholarly effort, versus an API client/utility. This should take a week or two at most.

In the meantime, any additional context would be welcome.

[prakaa]

Hi @kyleniemeyer, thanks for your response and for taking the time to look at this.

I have tried to address some of these points below in the paper, but I hope this additional context below is useful:

• I think the examples in the docs provide significant value to users.
  • They are focused on forecast errors as this is likely of interest to many users. Since the scope of the package is wider than power system and electricity market forecast errors, functions that explicitly calculate these have not been implemented in the package itself.
  • However the docs provide coded examples of how NEMSEER and sister packages can be used to calculate and characterise these errors
  • An example: this online companion to a PESGM23 conference paper contains scripts that show that the researchers used code directly from the energy price convergence example in the docs.
• Beyond the examples, the package's documentation also acts as a repository of otherwise disparate knowledge about the datasets.

Based on this, I think NEMSEER makes addressing research challenges significantly better (faster, easier, simpler) and assists researchers in extracting knowledge from large data sets. I think it's fair to say that a lot of this value is delivered not only through the package, but also through the accompanying documentation (with examples).

[kyleniemeyer]

Thanks @prakaa, we will proceed to review with this one. The next step is assigning an editor, then finding reviewers.

[kyleniemeyer]

@editorialbot invite @fraukewiese as editor

Hi @fraukewiese, could you edit this submission instead? It's alright if it takes some time before finding reviewers, while you wrap up other submissions you are handling.

[editorialbot]

Invitation to edit this submission sent!

[fraukewiese]

Thanks for the invitation. I have to decline this time.

[kyleniemeyer]

Hi @prakaa, apologies, but I have to place your submission on the waitlist, while we find an editor with availability to handle this. In the meantime, any potential reviewer suggestions are welcome.

[prakaa]

@kyleniemeyer thanks for letting me know, appreciate the JOSS editorial team is probably quite busy.

Potential reviewers:
James Foster (https://github.com/jd-foster) and Changlong Wang (https://github.com/changlongw)

[arfon]

@editorialbot assign me as editor

[editorialbot]

Assigned! @arfon is now the editor

[arfon]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

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

[xuanxu]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

elmada: Dynamic electricity carbon emission factors and prices for Europe
Reviewers: @nmstreethran, @olejandro
Similarity score: 0.8113

skedm: Empirical Dynamic Modeling
Reviewers: @johnh2o2
Similarity score: 0.8024

MetSim: A Python package for estimation and disaggregation of meteorological data
Reviewers: @Chilipp, @dsryberg
Similarity score: 0.7977

Easy SimAuto (ESA): A Python Package that Simplifies Interacting with PowerWorld Simulator
Reviewers: @robinroche, @tonyelhabr
Similarity score: 0.7966

diyepw: A Python package for Do-It-Yourself EnergyPlus weather file generation
Reviewers: @samuelduchesne, @fneum
Similarity score: 0.7963

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before before considering asking the reviewers of these papers to review again for JOSS.

[arfon]

Apologies for all of the noise @prakaa! @xuanxu and I were debugging a small issue with GitHub Actions.

[arfon]

@mfleschutz @blthayer @amandadsmith – 👋 would any of you be willing to review this submission for JOSS? The submission under consideration is iNEMSEER: A Python package for downloading and handling historical National Electricity Market forecast data produced by the Australian Energy Market Operator: https://github.com/UNSW-CEEM/NEMSEER

As previous authors of somewhat similar packages, we think you might be able to provide a great review of this submission. Please let me know if you think you can help us out!

Many thanks
Arfon

[amandadsmith]

@arfon I'd be interested

[arfon]

@amandadsmith – great, thanks! I'll open the actual review issues shortly (once I've identified a second reviewer). For now, please sit tight!

[mfleschutz]

@arfon I am not available this week but happy to review after that.

[arfon]

@editorialbot add @mfleschutz as reviewer

[editorialbot]

@mfleschutz added to the reviewers list!

[arfon]

@editorialbot add @amandadsmith as reviewer

[editorialbot]

@amandadsmith added to the reviewers list!

[arfon]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #5883.

[arfon]

@mfleschutz, @amandadsmith – thanks for agreeing to review this submission to JOSS. See you over in #5883 where the actual review will take place.