Implementation of the QCRad algorithm for irradiance quality control #19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
First cut porting the implementation from solarforeacstarbiter. * Adds qcrad filtering functions to quality.irradiance * Adds tests directory and test module to cover the new irradiance checks. * Adds a licenses.rst file to the documentation to keep track of opensource liscences and copyright notices.
The QCRad implementation does not use pandas directly Clearsky functions are not implemented yet.
- Two lines before functions. - Remove trailing empty lines.
adds __init__.py files in tests tree to satisfy pytest's package structure requirements.
Enables the autodoc, autosummary, and napoleon sphinx extensions to generate docs from docstrings. Adds api file to documentation tree with documentation for the qcrad functions in `quality.irradiance`
- Properly format math expressions. - Remove references from summary lines. - Clean up return types for check_irradiance_limits_qcrad - Format notes/warnings with reST directives
These docstrings contian a '\' character (escapes the _ in the generated docs) that should be interpreted literally.
The qcrad checks do not fully excercise this function on their own.
PEP 8 recommends line breaks before binary operators rather than after.
- Use the imperative voice in first line ("test for..." rather than
"tests for...").
- Single line doc strings fit on one line (including quotes)
- No blank line after function doc string.
cwhanse
reviewed
Mar 5, 2020
|
Yes, the tests are also from solarforecastarbiter. |
wfvining
commented
Mar 5, 2020
For check_*_limits_qcrad functions limits only needs to have keys corresponding to the specific measurement being checked (ghi/dhi/dni). This change makes it clear what keys are actually required for each function. Additional keys are allowed (i.e. we use QCRAD_LIMITS as the default for all functions) but are ignored.
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
The name of the series was used in solarforecastarbiter, but it does not add value here. This removes it so it. Because the name is not set, we also have to update the tests to ignore `Series.name`.
Forgot to run the linter locally after updating the test suite.
|
A general request as you port algorithms from SFA to pvanalytics... I'd like to think that SFA will eventually use the implementations here, and it would be helpful if the PRs summarized any changes made in the process. Perhaps the initial PR comment could be edited to keep track of the changes. |
Including the name doesn't add any information for functions that return only one value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ports the implementation of the QCRad algorithm from SolarArbiter/solarforecastarbiter-core
Changes from SolarForecastArbiter
mask_flagsdecoratorSeries.namefor returned masks