-
Notifications
You must be signed in to change notification settings - Fork 35
Solar Data Tools Submission #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Editor in Chief checksHi @pluflou ! Thank you for submitting your package for pyOpenSci review. Please check our Python packaging guide for more information on the elements below.
Editor commentsSolar Data Tools is in excellent condition! Congratulation for all your work! 🚀 My only comment is related to the test coverage, which could be improved. |
I saw a new 1.6.2 version was released while waiting for my feedback: I took the liberty to update the version submitted so the reviewers would deal with the latest version available. |
Thank you!! |
Hi @pluflou , I am glad to announce that we have an editor for Solar Data Tools review. @shirubana kindly accepted to take care of your submission. I am letting her introduce herself here and wishing a nice review process to all people involved. |
Thank you @shirubana for volunteering to review our package! We are excited to work with you on this. In the meantime, please let us know if you have any questions! |
Hi, starting on this and navigating the various resources to do this properly. |
Ok, I think I am acquainted now with the steps/my job after perusing the guide and slack. I have started to look for reviewers. |
Thank you @shirubana! Looking forward to working with you on this. |
Hi @shirubana! I just wanted to check in and see if there were any updates, and if there was anything you needed from us. Thank you! |
@cmarmo @shirubana is it possible to update to the latest version (1.6.4)? This version is now available on conda-forge (previous versions were on a private channel). |
@pluflou , since the review has not started yet, I have updated the information about the submitted version in the description. @shirubana, please let us know if you need any help to find reviewers.... unfortunately, onboarding reviewers can be tricky.... |
Hi @cmarmo @shirubana, happy new year! Just wanted to check in on how things are going, and have a small update. We have the JOSS paper in a branch's ( |
Hi Team 👋🏻 it would be great to move this review forward. I am happy to post on social to try to help find reviewers if someone can help me understand what we need here! ✨ I know it's a challenging time here in the US for science so it's super understandable that things might move more slowly because of that! |
Sorry for the late reply. I finished my defense earlier this month, and should be able to give my comments in two or three days. |
@jinningwang congrats on the defense! |
Thanks for the efforts in this work! My review report is here. Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Readme file** **requirements The package meets the readme requirements below:
The README should include, from top to bottom:
** **- [x] Continuous integration and test coverage, ** **- [x] Docs building (if you have a documentation website), ** **- [x] A repostatus.org badge, ** **- [x] Python versions supported, ** **- [x] Current package version (on PyPI / Conda). NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)
** **- [x] Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)
UsabilityReviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole. Package structure should follow general community best-practices. In general please consider whether:
Functionality
** **- [x] All tests pass on the reviewer's local machine for the package version submitted by the author. Ideally this should be a tagged version making it easy for reviewers to install. ** **- [x] Tests cover essential functions of the package and a reasonable range of inputs and conditions.
** **A few notable highlights to look at: ** **- [x] Package supports modern versions of Python and not End of life versions. ** **- [ ] Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass) For packages also submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted. The package contains a
Final approval (post-review)
Estimated hours spent reviewing:
|
Thank you so much @jinningwang ! And congratulations on your defense! |
Thank you so much everyone! We really appreciate your time and comments! I will work on getting the changes/responses back by the end of May. |
Hi all, Many thanks to @cdeline, @echedey-ls and @jinningwang for their reviews. I have created three PRs that address the reviewers' comments, as well as Issues that note things that were raised that weren't gating for this review for future work. Please feel free to review/comment as needed. Open PRs
Open Issues (for future work)
If I missed anything, please let me know, otherwise, I'll wait for comments/approvals/confirmation before we merge the PRs. Thank you all! |
@pluflou thank you for your work! |
@cmarmo ok great, that sounds reasonable to me! I'll merge it tomorrow and ping everyone when I'm done. Thank you! |
Hi all, I have merged the changes to the main branch. Please let me know if you have any comments. Thank you! |
Thank you @pluflou for your follow-up! |
Looks good to me. I pulled changes and tested notebooks for functionality, everything appears to be working. Thanks for your efforts! |
Thank you @cdeline for your answer! Do you mind checking the checkbox (sorry for the lack of vocabulary...) accepting the package at the end of your review if you are happy with the changes? Thanks! |
Thanks for the improvement and most changes are good to me. One last concern is: Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)
./sdt_dask/clients/local_client.py:61:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:62:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:70:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:80:80: E501 line too long (93 > 79 characters)
./sdt_dask/clients/local_client.py:85:80: E501 line too long (104 > 79 characters)
./sdt_dask/dask_tool/runner.py:3:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:4:80: E501 line too long (86 > 79 characters)
./sdt_dask/dask_tool/runner.py:75:80: E501 line too long (80 > 79 characters)
./sdt_dask/dask_tool/runner.py:89:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:118:80: E501 line too long (128 > 79 characters)
./sdt_dask/dask_tool/runner.py:135:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:156:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:201:80: E501 line too long (81 > 79 characters)
./sdt_dask/dask_tool/runner.py:214:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:57:80: E501 line too long (80 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:58:80: E501 line too long (80 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:75:80: E501 line too long (100 > 79 characters)
./sdt_dask/dataplugs/csv_plug.py:14:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/csv_plug.py:48:80: E501 line too long (82 > 79 characters)
./sdt_dask/dataplugs/dataplug.py:12:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/pvdb_plug.py:22:80: E501 line too long (81 > 79 characters)
...
A GitHub action might be useful for lint purpose and its integration in CI, https://github.com/marketplace/actions/lint-action |
@cdeline @jinningwang Thank you so much for reviewing the changes! @jinningwang I am using ruff for formatting, which may have different settings than flake8 (we can control them and make them match, but I left them mostly at default). I set up linting up using pre-commit hooks (you can see the instructions here on step 7), but you can also install ruff and run |
Thanks for your clarification! Then I have no more questions.
Thanks again for your excellent work!
Regards,
Jinning
…On Tue, Jun 10, 2025 at 22:39 Sara A. Miskovich ***@***.***> wrote:
*pluflou* left a comment (pyOpenSci/software-submission#210)
<#210 (comment)>
@cdeline <https://github.com/cdeline> @jinningwang
<https://github.com/jinningwang> Thank you so much for reviewing the
changes!
@jinningwang <https://github.com/jinningwang> I am using ruff for
formatting, which may have different settings than flake8 (we can control
them and make them match, but I left them mostly at default). I set up
linting up using pre-commit hooks (you can see the instructions here on
step 7
<https://github.com/slacgismo/solar-data-tools/blob/main/CONTRIBUTING.md>),
but you can also install ruff and run ruff check and ruff format. The
settings for the ruff checks are in here
<https://github.com/slacgismo/solar-data-tools/blob/792df3f325b87f11690e60848d1915422bf3fe12/.pre-commit-config.yaml#L20>.
The workflow is running the linting check on this line
<https://github.com/slacgismo/solar-data-tools/blob/792df3f325b87f11690e60848d1915422bf3fe12/.github/workflows/lint.yml#L38>.
What you are seeing is due to the fact that ruff does not enforce E501 by
default, and I did not add it, but it would be straightforward to do so if
that's your recommendation. Let me known if you have other questions/your
thoughts.
—
Reply to this email directly, view it on GitHub
<#210 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AS4OJPM4QNS3D2FAR5BZLML3C6JGZAVCNFSM6AAAAABMVE3TOSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNRRGA2TEOJSHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Thank you @jinningwang for your review! We really appreciate it. @cmarmo Could you let me know what the next steps are? We also have a JOSS paper in the repo, but I'm not sure what the process is after this. |
@pflou, as soon as @echedey-ls will finalise his answer, we can declare the package accepted and move forward with the JOSS submission. |
Everything's ok from my side. I had already seen those PRs, not the main code, due to my lack of free time lately. Good job! |
Wonderful! I guess it's time to move to the next step then. 🎉 Solar Data Tools has been approved by pyOpenSci! Thank you @pluflou for submitting and many thanks to @cdeline, @echedey-ls and @jinningwang for reviewing this package! 😸 Author Wrap Up TasksThere are a few things left to do to wrap up this submission:
It looks like you would like to submit this package to JOSS. Here are the next steps:
Editor Final ChecksPlease complete the final steps to wrap up this review. Editor, please do the following:
If you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the peer-review-guide. |
@pluflou, @bmeyers, @cdeline, @echedey-ls and @jinningwang, please let me know if you are interested in an invite to the pyopensci Slack, I will be happy to provide you with it. Also if the authors are interested in writing a blogpost about the review process pyopensci can provide the infrastructure to host it. |
I can join it. Do I need to register it first?
Regards,
Jinning
…On Fri, Jun 13, 2025 at 13:05 Chiara Marmo ***@***.***> wrote:
*cmarmo* left a comment (pyOpenSci/software-submission#210)
<#210 (comment)>
@pluflou <https://github.com/pluflou>, @bmeyers
<https://github.com/bmeyers>, @cdeline <https://github.com/cdeline>,
@echedey-ls <https://github.com/echedey-ls> and @jinningwang
<https://github.com/jinningwang>, please let me know if you are
interested in an invite to the pyopensci Slack, I will be happy to provide
you with it.
Also if the authors are interested in writing a blogpost about the review
process pyopensci can provide the infrastructure to host it.
—
Reply to this email directly, view it on GitHub
<#210 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AS4OJPIOR5R75CERPWRYD433DMAEHAVCNFSM6AAAAABMVE3TOSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNZQHE4DGNZQGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
@jinningwang you are right, you are already in! No need for an invite! 🙂 |
Thank you @cmarmo! Please add me to the Slack channel! I update the remaining tasks below, I will update as things progress with JOSS. Who submits the JOSS issue? Author Wrap Up Tasks
|
Thank you @pluflou ! Do you mind creating a new release containing the modifications originated by the review? The 1.7.1 is dated back to April. The new one will be the version accepted by pyOpenSci.
The authors / maintainers of the package take care of the submission: be sure to mention and link to the approved pyOpenSci review. Thanks a lot! |
Uh oh!
There was an error while loading. Please reload this page.
Submitting Author: Sara Miskovich (@pluflou)
All current maintainers: (@pluflou, @bmeyers)
Package Name: Solar Data Tools
One-Line Description of Package: Library of tools for analyzing photovoltaic power time-series data.
Repository Link: https://github.com/slacgismo/solar-data-tools
Version submitted: 1.6.4
EiC: @cmarmo
Editor: @shirubana
Reviewer 1: @jinningwang
Reviewer 2: @echedey-ls
Reviewer 3: @cdeline
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): 06/13/2025
Code of Conduct & Commitment to Maintain Package
Description
Solar Data Tools is an open-source Python library for analyzing PV power (and irradiance) time-series data. It provides methods for data I/O, cleaning, filtering, plotting, and analysis. These methods are largely automated and require little to no input from the user regardless of system type—from utility tracking systems to multi-pitch rooftop systems. Solar Data Tools was developed to enable analysis of unlabeled PV data, i.e. with no model, no meteorological data, and no performance index required, by taking a statistical signal processing approach in the algorithms used in the package’s main data processing pipeline.
Scope
Please indicate which category or categories.
Check out our package scope page to learn more about our
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
Domain Specific
Community Partnerships
If your package is associated with an
existing community please check below:
For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
Who is the target audience and what are scientific applications of this package?
This package is for anyone dealing with photovoltaic data, especially data with no meteorological information (unlabeled). This includes photovoltaic professionals (in private solar industry or utility companies for example), researchers and students in the solar power domain, community solar owners, and anyone with a rooftop system. The scientific goal of the package is to facilitate analysis of photovoltaic data for any system, even those that are difficult to model, and the package uses signal decomposition to achieve that.
Are there other Python packages that accomplish the same thing? If so, how does yours differ?
There are two other packages that are similar in that they offer data analysis tools for solar applications: PVAnalytics and RdTools. They are both model driven, and require the user to define their own analysis. PVAnalytics focuses on preprocessing and QA, while RdTools focuses on loss factor analysis. Solar Data Tools provides both data quality and loss factor analysis, runs automatically with little to no setup, and is model-free and does not require any weather or other information. Solar Data Tools is most suited for when users want a pre-defined pipeline to get information on complex systems/sites that can't be modeled easily and that no meteorological data. A recent tutorial that was part of a virtual tutorial series on open-source tools and open-access solar data held by DOE’s Solar Technology Office in March 2024 goes over the differences in these packages and when each tool is appropriate to use. You can find the recording here and the slide deck here (see slide 16 for a summary).
If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@tag
the editor you contacted:Solar Data Tools pre-submission inquiry #204 (@cmarmo)
Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication Options
JOSS Checks
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
. (will add soon)Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.
Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Confirm each of the following by checking the box.
Please fill out our survey
submission and improve our peer review process. We will also ask our reviewers
and editors to fill this out.
P.S. Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
The editor template can be found here.
The review template can be found here.
Footnotes
Please fill out a pre-submission inquiry before submitting a data visualization package. ↩
The text was updated successfully, but these errors were encountered: