Code and example for classifying snow effects #209

cwhanse · 2024-04-08T15:01:05Z

Closes Quantify power losses due to snow cover #200
Added tests to cover all new or modified code.
Clearly documented all new API functions with PEP257 and numpydoc compliant docstrings.
Added new API functions to docs/api.rst.
Non-API functions clearly documented with docstrings or comments as necessary.
Adds description and name entries in the appropriate "what's new" file
in docs/whatsnew
for all changes. Includes link to the GitHub Issue with :issue:`num`
or this Pull Request with :pull:`num`. Includes contributor name
and/or GitHub username (link with :ghuser:`user`).
Pull request is nearly complete and ready for detailed review.
Maintainer: Appropriate GitHub Labels and Milestone are assigned to the Pull Request and linked Issue.

…rize()

kandersolar

Here's a review of the new functions. FYI I anticipate at least one more round of review after this one is done.

docs/api.rst

pvanalytics/features/snow.py

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

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

kandersolar

Another partial review. High-level thoughts:

The gallery example does too much. Simpler would be better. I think reducing it to a single inverter, or even a single combiner box, would be an improvement. I also think getting rid of unnecessary steps (e.g. horizon, SDM) would help.
I am a little uncomfortable with the functions being only loosely tied to the reference (at least by pvlib-python standards). The code both extends the reference (e.g. adding a new mode) and fills in many gaps where the reference doesn't give specifics. It seems that these changes are necessary, so maybe all we can do is document the differences.

docs/whatsnew/0.2.1.rst

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

kandersolar · 2024-09-27T14:18:18Z

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

+data['Horizon Mask'] = snow._get_horizon_mask(horizon, data['azimuth'],
+ data['elevation'])


I don't think this function should live in pvanalytics.snow, and I'm not sure it needs to be in pvanalytics at all. If the horizon filter is retained, should this function be converted to a helper function here in the script?

kandersolar · 2024-09-27T14:30:42Z

pvanalytics/features/snow.py

+ .. [1] C. F. Abe, J. B. Dias, G. Notton, G. A. Faggianelli, G. Pigelet, and
+ D. Ouvrard, David, "Estimation of the effective irradiance and bifacial
+ gain for PV arrays using the maximum power current", IEEE Journal of
+ Photovoltaics, 2022, pp. 432-441. :doi:`10.1109/JPHOTOV.2023.3242117`


Suggested change

.. [1] C. F. Abe, J. B. Dias, G. Notton, G. A. Faggianelli, G. Pigelet, and

D. Ouvrard, David, "Estimation of the effective irradiance and bifacial

gain for PV arrays using the maximum power current", IEEE Journal of

Photovoltaics, 2022, pp. 432-441. :doi:`10.1109/JPHOTOV.2023.3242117`

.. [1] C. F. Abe, J. B. Dias, G. Notton, G. A. Faggianelli, G. Pigelet,

and D. Ouvrard, "Estimation of the effective irradiance and bifacial

gain for PV arrays using the maximum power current", IEEE Journal of

Photovoltaics, 2022, pp. 432-441. :doi:`10.1109/JPHOTOV.2023.3242117`

Something weird is happening with the rendering here. I am guessing sphinx is interpreting the leading C. and D. as indicating an enumerated list. I'm not sure, but I think this tweak (not having D. at the start of the second line) might get sphinx to render it as intended.

kandersolar · 2024-09-27T17:20:55Z

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

+ data['Module Temp [C]'], data['POA [W/m²]'], 3)
+
+# %%
+# Plot cell temperature


I don't think this plot adds much. I would remove it, again to simplify things.

kandersolar · 2024-09-27T17:22:35Z

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

+# Approach 2 %TODO not sure we need this
+# Code borrowed from pvlib-python/docs/examples/iv-modeling/plot_singlediode.py


Again for simplification, I suggest calculating voltage only one way. The other way could be briefly mentioned as an alternative.

kandersolar · 2024-09-27T17:25:28Z

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

+# %%
+# Function to do analysis so we can loop over combiner boxes
+
+def wrapper(voltage, current, temp_cell, effective_irradiance,


wrapper is not a very informative name. get_snow_mode, perhaps?

kandersolar · 2024-09-27T17:35:19Z

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

+ Keys are ``'transmission'``, ``'modeled_vmp'``, ``'vmp_ratio'``,
+ and ``'mode'``


These keys need to be updated according to what the function actually returns

Also, maybe return a dataframe instead of a dict?

kandersolar · 2024-09-27T17:39:29Z

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

+
+# %%
+# Demonstrate transmission, modeled voltage calculation and mode categorization
+# on voltage, current pair


I don't think this cell is necessary; it's just a copy of the body of the for loop in the next cell.

Suggestions from review Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

cwhanse · 2024-09-27T22:03:24Z

Another partial review. High-level thoughts:

The gallery example does too much. Simpler would be better.

Thanks for this. I needed an outside perspective, and I will overhaul the example to handle data from a single combiner.

I am a little uncomfortable with the functions being only loosely tied to the reference (at least by pvlib-python standards). The code both extends the reference (e.g. adding a new mode) and fills in many gaps where the reference doesn't give specifics. It seems that these changes are necessary, so maybe all we can do is document the differences.

Agreed, but I'm not sure there's an option besides document here, or abandon the PR. A revised reference paper is very unlikely.

kandersolar · 2024-10-04T13:58:11Z

Test failure is in test_daytime.py; not caused by this PR. See pvlib/pvlib-python#2238

cwhanse and others added 30 commits April 8, 2024 08:59

initial load of snow mode detection

455a1ae

lint

096d480

fix file opens

bfe3642

Merge branch 'main' of https://github.com/pvlib/pvanalytics into snow

14caa28

add README

c0d47b3

formatting

eae4a84

fix import

83592a2

fix file name

ac12f36

fix up horizon code, add test

556fefc

fix horizon file name

025b74b

update mask function

acf0b4e

linting

0b8720d

work toward vectorizing categorize

1f7a0d6

lint, use mode None instead of -1

e4e2219

use None in test

fc2fd20

use dtype object to have both int and None

8a73eef

handle mixed types

32619fb

add tests

42e582a

handle equals

2af3fa0

Fixed the horizon masking section

9a1494c

Linting

3cc7c55

Added argument to test_categorize() to reflect changes made to catego…

a4465b7

…rize()

last lint i promise!

4ad80cd

remove old categorize

cb67705

Fixed failing test

6de642c

Fixed failing test

409a29e

fix offline

c0d0a3f

Merge branch 'snow' of https://github.com/cwhanse/pvanalytics into snow

6e93d0d

0 not None

ccfac03

edit definitions of mode

0d5c087

eccoope and others added 4 commits June 4, 2024 13:27

Uncomment directory definition

1ae4824

Removed unused import statement

037b0bd

Shorted line length to 79 characters

8f382d5

resolved merge conflicts

8d7de2e

kandersolar reviewed Jun 27, 2024

View reviewed changes

eccoope and others added 16 commits June 27, 2024 10:38

Update pvanalytics/features/snow.py

e7ad7d2

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

Update pvanalytics/features/snow.py

5b96547

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

Update pvanalytics/features/snow.py

acf4aef

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

Update pvanalytics/features/snow.py

40ef5a2

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

Madking changes recommended by Kevin

86c451c

Linting

50e17da

changed name of hidden function in test

b5335c6

Linting again

523ded3

put Bug fixes back in whatsnew

46f089d

fix merge

6a7420a

catchup with github changes

e7be3a7

doc improvements

741e721

save the file first

35cbb7c

adjust colors

ba1694f

figure nidges

335478c

figure nidges

be3eef5

cwhanse commented Sep 10, 2024

View reviewed changes

docs/examples/snow-detection/snow-mode.py Outdated Show resolved Hide resolved

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

fff5452

kandersolar reviewed Sep 27, 2024

View reviewed changes

cwhanse and others added 3 commits September 27, 2024 12:16

small edits

9dbc990

Merge branch 'snow' of https://github.com/cwhanse/pvanalytics into snow

4075739

Apply suggestions from code review

8cd1fca

Suggestions from review Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

overhaul example, remove horizon

9335a74

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code and example for classifying snow effects #209

Code and example for classifying snow effects #209

cwhanse commented Apr 8, 2024 •

edited

Loading

kandersolar left a comment

kandersolar left a comment

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

kandersolar Sep 27, 2024

cwhanse commented Sep 27, 2024

kandersolar commented Oct 4, 2024

		data['Horizon Mask'] = snow._get_horizon_mask(horizon, data['azimuth'],
		data['elevation'])

		# Approach 2 %TODO not sure we need this
		# Code borrowed from pvlib-python/docs/examples/iv-modeling/plot_singlediode.py

		Keys are ``'transmission'``, ``'modeled_vmp'``, ``'vmp_ratio'``,
		and ``'mode'``

Code and example for classifying snow effects #209

Are you sure you want to change the base?

Code and example for classifying snow effects #209

Conversation

cwhanse commented Apr 8, 2024 • edited Loading

kandersolar left a comment

Choose a reason for hiding this comment

kandersolar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwhanse commented Sep 27, 2024

kandersolar commented Oct 4, 2024

cwhanse commented Apr 8, 2024 •

edited

Loading