Martinez shading factor #2070

echedey-ls · 2024-05-27T23:58:34Z

Closes Shading model that takes into account the bypass diodes and layout of modules #2063
I am familiar with the contributing guidelines
Tests added
Updates entries in docs/sphinx/source/reference for API changes.
Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/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`).
New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
Pull request is nearly complete and ready for detailed review.
Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

Addresses adding the shading model described in #2063, which divides the modules into blocks, i.e. groups of cells protected by bypass diodes. It is applied to the unshaded output power.

Tests have been made with the original paper data, that is not explicitly in the paper.

The most difficult part of this model is documenting the blocks IMO. Please have a look at it.

Docs links
- https://pvlib-python--2070.org.readthedocs.build/en/2070/reference/generated/pvlib.shading.direct_martinez.html
- https://pvlib-python--2070.org.readthedocs.build/en/2070/gallery/shading/plot_martinez_shade_loss.html

From NREL paper

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Co-Authored-By: Anton Driesse <9001027+adriesse@users.noreply.github.com>

Co-Authored-By: Will Holmgren <william.holmgren@gmail.com> Co-Authored-By: Mark Mikofski <bwana.marko@yahoo.com>

…acking.singleaxis

Co-Authored-By: Cliff Hansen <5393711+cwhanse@users.noreply.github.com>

https://pandemic-overview.readthedocs.io/en/latest/myGuides/reStructuredText-Images-and-Figures-Examples.html#id18

echedey-ls · 2024-06-15T19:31:26Z

Ready for another review guys!! @kandersolar @cwhanse and everyone else ^.^

kandersolar · 2024-06-17T21:09:17Z

I don't quite understand the need of three variables here

I wondered the same thing as I was typing it out :) I more intended to just list the variables in the equations. I'm not saying we should necessarily use that specific function signature (although I see my comment could easily be read that way).

I'm not familiar with pvlib widely using it.

Not widely used, but sometimes used. It is currently available from some transposition models (e.g. pvlib.irradiance.perez) and perhaps someday the rest as well (#1553).

Anyway yes I agree, dropping the poa_circumsolar probably makes sense. I suggest keeping poa_direct and mentioning in the docstring that it should be given the sum of direct+circumsolar.

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

…ls/pvlib-python into martinez-shading-factor

pvlib/shading.py

docs/examples/shading/plot_martinez_shade_loss.py

pvlib/tests/test_shading.py

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> Co-Authored-By: Ioannis Sifnaios <88548539+IoannisSifnaios@users.noreply.github.com>

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

pvlib/shading.py

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

echedey-ls · 2024-06-18T23:00:21Z

Thank you very much for your reviews @kandersolar & @cwhanse ❣️

From my side, I think all comments have been addressed.

AdamRJensen

Just minor details

pvlib/shading.py

AdamRJensen · 2024-06-20T16:11:55Z

pvlib/shading.py

+    A shading losses power factor for non-monolithic Silicon
+    modules and arrays with an arbitrary number of bypass diodes.
+
+    This experimental model cancels a fraction of the direct and circumsolar


I don't understand what "cancels" means in this context

I've changed the verb to "zeroes":

This experimental model zeroes a fraction of the direct and circumsolar

I may have not translated that correctly. I've seen "to zero" as a verb. Should I reword it to something along This experimental model decreases a fraction of the direct and circumsolar with each shaded block

Let's use the word reduces

This experimental model reduces a fraction of the direct and circumsolar with each shaded block

pvlib/shading.py

AdamRJensen · 2024-06-20T16:16:41Z

pvlib/shading.py

+    **Blocks terminology:**
+
+    [1]_ defines a *block* as a group of solar cells protected by a bypass
+    diode. Also, a *block* is shaded when at least one of its cells is shaded.


If one of its cells is "partly" shaded or "completely" shaded?

A block is shaded when at least one of its cells is shaded. A first possibility is to consider that the power of a block is fully cancelled when the block is shaded.

The paper does not specify it, but from the original tests spreadsheet I confirm they are considered shaded if a minimal amount of shade impacts on them.

I've added partially to the docstring, thou maybe I shouldn't.

I like it! Especially if you've confirmed with the spreadsheet

docs/examples/shading/plot_martinez_shade_loss.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

pvlib/shading.py

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

kandersolar · 2024-06-21T11:43:16Z

Great contribution @echedey-ls!

echedey-ls and others added 30 commits March 8, 2024 16:46

Update shading.py

c87885c

Minimal test

4fc6cd8

Implementation

2a72f33

From NREL paper

Fix, fix, fix, fix & format

d6e8067

Format issues

13a56d4

Extend tests (compare with singleaxis) & format with ruff

f012aae

Format fixes

6dd9a3b

Upgrade tests

e8743db

Array -> Axis

6030774

type

6276382

Whatsnew

509699f

xd

5ff8fd8

bruh

04126e0

Minor Python optimization a la tracking.singleaxis

607a246

Comment and minor optimizations

240b551

Surface -> Axis

997def6

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Elevation -> Zenith

7912055

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Elev -> Zenith

f068e3e

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Update shading.py

a5f4a85

Update docstring

a854e27

Co-Authored-By: Anton Driesse <9001027+adriesse@users.noreply.github.com>

Add comments from tracking.singleaxis

2d82375

Co-Authored-By: Will Holmgren <william.holmgren@gmail.com> Co-Authored-By: Mark Mikofski <bwana.marko@yahoo.com>

Singleaxis implementation port & test addition, based on old pvlib.tr…

5f24721

…acking.singleaxis

Update v0.10.4.rst

049a8cc

Linter

a3185df

Code review

b9f1a76

Co-Authored-By: Cliff Hansen <5393711+cwhanse@users.noreply.github.com>

Add Fig 5 [1] (still gotta check the built output)

f7d1d80

Add caption, change size and describe in alternate text

1880f6a

rST fixes ?

d9f242a

Figures have captions, images do not

379ca95

https://pandemic-overview.readthedocs.io/en/latest/myGuides/reStructuredText-Images-and-Figures-Examples.html#id18

Flip arguments order

62e99ad

echedey-ls marked this pull request as ready for review June 15, 2024 19:30

echedey-ls and others added 3 commits June 17, 2024 23:11

Merge branch 'main' into martinez-shading-factor

c444639

Change poa_direct_and_circumsolar to poa_direct

48a9004

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Merge branch 'martinez-shading-factor' of https://github.com/echedey-…

e4076f7

…ls/pvlib-python into martinez-shading-factor

kandersolar reviewed Jun 18, 2024

View reviewed changes

echedey-ls and others added 9 commits June 18, 2024 21:55

Example link

9da4834

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

power_loss -> loss_fraction

6ef91b8

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Typo when applying Ioannis suggestion

37d4ca0

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> Co-Authored-By: Ioannis Sifnaios <88548539+IoannisSifnaios@users.noreply.github.com>

Re-arrange POA to its own section in example

329fe23

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Mis-redaction in normal/half-cut modules comparison

cf9acec

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Add edge cases

8180654

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Link yet again

874c0a4

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Fix link for sure

46cedd8

Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Remove critical error from docs build

954b05f

cwhanse approved these changes Jun 18, 2024

View reviewed changes

pvlib/shading.py Outdated Show resolved Hide resolved

pvlib/shading.py Outdated Show resolved Hide resolved

echedey-ls and others added 2 commits June 19, 2024 00:52

Apply suggestions from code review (Cliff)

00f1eff

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

Linter

ec3931f

AdamRJensen approved these changes Jun 20, 2024

View reviewed changes

echedey-ls and others added 4 commits June 20, 2024 20:13

Apply suggestions from Adam

8ed87b6

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

Merge branch 'main' into martinez-shading-factor

da0b75d

Rewording from code review

95769bf

Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

More unitless

8841020

Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

cwhanse reviewed Jun 20, 2024

View reviewed changes

pvlib/shading.py Outdated Show resolved Hide resolved

Apply suggestions from Cliff

9483fda

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

kandersolar merged commit 35599e7 into pvlib:main Jun 21, 2024
30 checks passed

echedey-ls deleted the martinez-shading-factor branch June 21, 2024 11:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Martinez shading factor #2070

Martinez shading factor #2070

echedey-ls commented May 27, 2024 •

edited

Loading

echedey-ls commented Jun 15, 2024

kandersolar commented Jun 17, 2024

echedey-ls commented Jun 18, 2024

AdamRJensen left a comment

AdamRJensen Jun 20, 2024

echedey-ls Jun 20, 2024

AdamRJensen Jun 20, 2024

AdamRJensen Jun 20, 2024

echedey-ls Jun 20, 2024 •

edited

Loading

echedey-ls Jun 20, 2024

AdamRJensen Jun 20, 2024

kandersolar commented Jun 21, 2024

Martinez shading factor #2070

Martinez shading factor #2070

Conversation

echedey-ls commented May 27, 2024 • edited Loading

Docs links

echedey-ls commented Jun 15, 2024

kandersolar commented Jun 17, 2024

echedey-ls commented Jun 18, 2024

AdamRJensen left a comment

Choose a reason for hiding this comment

AdamRJensen Jun 20, 2024

Choose a reason for hiding this comment

echedey-ls Jun 20, 2024

Choose a reason for hiding this comment

AdamRJensen Jun 20, 2024

Choose a reason for hiding this comment

AdamRJensen Jun 20, 2024

Choose a reason for hiding this comment

echedey-ls Jun 20, 2024 • edited Loading

Choose a reason for hiding this comment

echedey-ls Jun 20, 2024

Choose a reason for hiding this comment

AdamRJensen Jun 20, 2024

Choose a reason for hiding this comment

kandersolar commented Jun 21, 2024

echedey-ls commented May 27, 2024 •

edited

Loading

echedey-ls Jun 20, 2024 •

edited

Loading