-
Notifications
You must be signed in to change notification settings - Fork 32
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
Clipping sphinx documentation #134
Clipping sphinx documentation #134
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not seeing a thumbnail for this example in the RTD PR build and I'm not sure why. It works when I build locally, so I'm inclined to chalk it up to browser strangeness and ignore it here.
The 4.7 MB data file is a bit large. Our current distribution is only 80-90 kB (https://pypi.org/project/pvanalytics/#files), so adding this would increase the size by 50x! What do you think about cutting down that data file to just the period used in this example and/or removing the unnecessary columns?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good @kperrynrel . I would suggest using more descriptive legends, so that the two plots can be more easily identified as the labeled data and the detected clipping times.
Co-authored-by: Cliff Hansen <[email protected]>
Co-authored-by: Cliff Hansen <[email protected]>
@kanderso-nrel and @cwhanse made all the updates suggested. If you guys are good with it, I'll merge the PR into master. Thanks for the help with reviewing this! |
Description
This PR generates documentation for the clipping mask in pvlib.features. I added an example data set labeled for clipping, and compare the results of the mask to the ground-truth labeled data (taken from the Duramat data sets site). Related to issue #133.
Checklist
The following items must be addressed before the code can be merged.
Please don't hesitate to ask for help if you are unsure of how to accomplish any of the items.
You are free to remove any checklist items that do not apply or add additional items that are
not on this list
in
docs/whatsnew
for all changes. Includes link to the GitHub Issue with
:issue:`num`
or this Pull Request with
:pull:`num`
. Includes contributor nameand/or GitHub username (link with
:ghuser:`user`
).