Code and example for classifying snow effects (#209)

* initial load of snow mode detection

* lint

* fix file opens

* add README

* formatting

* fix import

* fix file name

* fix up horizon code, add test

* fix horizon file name

* update mask function

* linting

* work toward vectorizing categorize

* lint, use mode None instead of -1

* use None in test

* use dtype object to have both int and None

* handle mixed types

* add tests

* handle equals

* Fixed the horizon masking section

* Linting

* Added argument to test_categorize() to reflect changes made to categorize()

* last lint i promise!

* remove old categorize

* Fixed failing test

* fix offline

* 0 not None

* edit definitions of mode

* use pvlib function, punctuation

* lint, add note at head

* lint

* api, whatsnew

* implemented mode -1

* fixed import error that failed readthedocs

* linting (W291 flags on snow.py)

* more mode -1 changes

* linting

* Fixing readthedocs rendering

* fixed failing test

* Apply suggestions from code review

* doc build

* spaces

* maybe its this extra line?

* docstring edits

* addressed Kevin's comments

* Fixed import statements

* Uncomment directory definition

* Removed unused import statement

* Shorted line length to 79 characters

* Update pvanalytics/features/snow.py

Co-authored-by: Kevin Anderson <[email protected]>

* Update pvanalytics/features/snow.py

Co-authored-by: Kevin Anderson <[email protected]>

* Update pvanalytics/features/snow.py

Co-authored-by: Kevin Anderson <[email protected]>

* Update pvanalytics/features/snow.py

Co-authored-by: Kevin Anderson <[email protected]>

* Madking changes recommended by Kevin

* Linting

* changed name of hidden function in test

* Linting again

* put Bug fixes back in whatsnew

* doc improvements

* save the file first

* adjust colors

* figure nidges

* figure nidges

* Update docs/examples/snow-detection/snow-mode.py

* small edits

* Apply suggestions from code review

Suggestions from review

Co-authored-by: Kevin Anderson <[email protected]>

* overhaul example, remove horizon

* edits, I forget what

* major edits to example

* yet more edits

* lint

* Update docs/api.rst

* review comments

---------

Co-authored-by: eccoope <[email protected]>
Co-authored-by: Emma Cooper <[email protected]>
Co-authored-by: Kevin Anderson <[email protected]>

Author: 3 people

docs/api.rst

@@ -69,7 +69,7 @@ There is function for calculating the component sum for GHI, DHI,
 and DNI, and correcting for nighttime periods. Using this function, we can
 estimate one irradiance field using the two other irradiance fields.
 This can be useful for comparison, as well as to
-calculate missing data fields. 
+calculate missing data fields.
 
 .. autosummary::
    :toctree: generated/
@@ -269,6 +269,19 @@ Functions for labeling shadows.
 
    features.shading.fixed
 
+Snow
+----
+
+Functions for identifying and quantifying the effects of snow.
+
+.. autosummary::
+   :toctree: generated/
+
+   features.snow.get_irradiance_sapm
+   features.snow.get_irradiance_imp
+   features.snow.categorize
+   features.snow.get_transmission
+
 System
 ======
 

docs/examples/snow-detection/README.rst

@@ -0,0 +1,4 @@
+Snow
+----
+
+Examples for identifying the effects of snow.