pvanalytics icon indicating copy to clipboard operation
pvanalytics copied to clipboard

Adding Sphinx examples for each of the QA modules in the package.

Open kperrynrel opened this issue 3 years ago • 2 comments

Add Sphinx documentation to illustrate the value of each of the following modules, in order:

-clipping -Data gaps (gaps module) -Outlier detection and removal (outliers) -Irradiance -Day-night masking

Include example data for these modules in the /data/ folder.

kperrynrel avatar Feb 18 '22 23:02 kperrynrel

May be better to have one example per function instead of one example per module to keep them from getting overly lengthy. Also, we're not using it currently, but it's easy to configure sphinx-gallery to organize examples by topic.

kandersolar avatar Feb 21 '22 13:02 kandersolar

Additional modules to add documentation for: -orientation -shading -weather -metrics

kperrynrel avatar Mar 22 '22 22:03 kperrynrel