Add polo-smm #2491

jesuspolo · 2025-06-25T06:25:31Z

Add the polo spectral model for BIPV facades

~~[ ] Closes #xxxx~~
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.

Adding the spectral model for estimating spectral mismatch for BIPV in facades according to ref: Polo, J., Sanz-saiz, C., 2025. Development of spectral mismatch models for BIPV applications in building façades Abbreviations : Renew. Energy 245, 122820. https://doi.org/10.1016/j.renene.2025.122820

Add the polo spectral model for BIPV facades

AdamRJensen

@jesuspolo Thanks for opening your first PR!

I've made some formatting changes, to make sure that the code adheres to the standard flake8 conventions. If you go to the "File changed" tab of this PR, then you can click "Add suggestion to batch" one by one and then commit all of them at once.

pvlib/spectrum/mismatch.py

Co-authored-by: Adam R. Jensen <[email protected]>

AdamRJensen · 2025-06-25T08:43:40Z

@jesuspolo As you can see, the Python Flake8 linter action (shown at the bottom of this PR) failed, due to some formatting not adhering to the Flake8 standard (I guess I didn't manage to spot all of them). If you click the action you can see what still needs to be fixed.

Whenever you make changes online and you switch to working on GitHub Desktop, you need to remember to click the "Fetch origin" button to make sure you have the latest changes locally.

jesuspolo · 2025-06-25T08:54:23Z

Hi Adam, I don't know how to solve the problems, I've seen they are about line too long and spaces, but I don't know how to edit the code and solve (sorry for my few capabilities)

AdamRJensen · 2025-06-25T10:14:20Z

pvlib/spectrum/mismatch.py

    c = {
        'asi': (0.0056, -0.020, 1.014),
        'cigs': (-0.0009, -0.0003, 1),
        'cdte': (0.0021, -0.01, 1.01),
        'monosi': (0, -0.003, 1.0),
    }
-
-    if module_type is not None:
+     if module_type is not None:


Suggested change

if module_type is not None:

if module_type is not None:

echedey-ls · 2025-06-25T10:43:55Z

pvlib/spectrum/mismatch.py

+    [1]. Polo, J., Sanz-saiz, C., Development of spectral mismatch models
+    for BIPV applications in building façades Abbreviations : Renew. Energy 245
+    ,122820, 2025.:doi:`10.1016/j.renene.2025.122820`


Suggested change

[1]. Polo, J., Sanz-saiz, C., Development of spectral mismatch models

for BIPV applications in building façades Abbreviations : Renew. Energy 245

,122820, 2025.:doi:`10.1016/j.renene.2025.122820`

.. [1] J. Polo and C. Sanz-Saiz, 'Development of spectral mismatch models

for BIPV applications in building façades', Renewable Energy, vol. 245,

p. 122820, Jun. 2025,

:doi:`10.1016/j.renene.2025.122820`

This is the IEEE citation I get with Zotero.

echedey-ls · 2025-06-25T10:44:22Z

pvlib/spectrum/mismatch.py

+                         albedo=0.2):
+    """
+    Estimation of spectral mismatch for BIPV application in vertical facades.
+    Parameters


Suggested change

Parameters

Parameters

I think it won't render well in readthedocs without the margin.

echedey-ls · 2025-06-25T10:44:38Z

pvlib/spectrum/mismatch.py

+    ----------
+    precipitable_water : numeric
+        atmospheric precipitable water. [cm]
+


Suggested change

For consistency.

echedey-ls

Nice PR @jesuspolo !
There are a bunch of tasks to fulfil so this new feature becomes available to users (most of them are in the PR body):

Reference it in docs\sphinx\source\reference\effects_on_pv_system_output\spectrum.rst (so it appears in the documentation, once done, we will be able to review the built docs that appear down below)
Add a whatsnew entry in docs\sphinx\source\whatsnew
Add tests - the better the exhaustive and the most edge-cases they check

echedey-ls · 2025-06-25T10:49:38Z

pvlib/spectrum/mismatch.py

+        c_albedo = (0.0, 0.0, 1.0)  # 0.2 albedo assumed
+        albedo = 0.2


I don't know if this is intentional, but this will ignore whatever value the user provides. If it's intentional, the docstring does not reflect that albedo is only used when the type is given, and assumed 0.2 when given the coefficients.

Add test of use of spectral_factor_polo fuction (pull pvlib#2491)

RDaxini

Thank you for this contribution @jesuspolo
I just made a couple of small suggestions for changes to the docstring: rephrasing the summary line and linking the parameter terms to their respective definition on the nomenclature page.
You might already be working on this anyway, but I wanted to add that besides the test you already wrote, it would be good to add tests for edge cases like Echedey suggested. For example, how the function handles inputs such as NaN and 0, or how it handles inputs of different data types such as series or dataframe. I'm happy to help write and/or review such tests if you need, just ask.

RDaxini · 2025-06-30T21:39:35Z

pvlib/spectrum/mismatch.py

+    airmass_absolute : numeric
+        absolute (pressure-adjusted) airmass. [unitless]
+    aod500 : numeric
+        atmospheric aerosol optical depth at 500 nm. [unitless]
+    aoi : numeric
+        angle of incidence. [degrees]


It would be nice to link these terms to their respective definitions on the nomenclature page. Not all definitions on that page have been fully developed, but we can link over to them anyway and they will soon be updated.

Suggested change

airmass_absolute : numeric

absolute (pressure-adjusted) airmass. [unitless]

aod500 : numeric

atmospheric aerosol optical depth at 500 nm. [unitless]

aoi : numeric

angle of incidence. [degrees]

airmass_absolute : numeric

absolute (pressure-adjusted) airmass. See :term:`airmass_absolute`. [unitless]

aod500 : numeric

atmospheric aerosol optical depth at 500 nm. [unitless]

aoi : numeric

angle of incidence. See :term:`aoi`. [degrees]

For aoi, I think the definition here should be angle of incidence on the vertical surface, and maybe we don't link to the generic aoi term.

RDaxini · 2025-06-30T21:42:30Z

pvlib/spectrum/mismatch.py

+    albedo
+        Ground albedo (default value if 0.2). [unitless]


Suggested change

albedo

Ground albedo (default value if 0.2). [unitless]

albedo

Ground albedo (default value if 0.2). See :term:`albedo`. [unitless]

RDaxini · 2025-06-30T21:43:07Z

pvlib/spectrum/mismatch.py

+        * ``'monosi'`` - anonymous sc-si module.
+        * ``'cigs'`` - anonymous copper indium gallium selenide module.
+        * ``'asi'`` - anonymous amorphous silicon module.
+    albedo


I was more wondering if the code allows for albedo being passed in as a time series?

+1 to making this possible if not already

RDaxini · 2025-06-30T21:45:34Z

pvlib/spectrum/mismatch.py

+                         altitude, module_type=None, coefficients=None,
+                         albedo=0.2):
+    """
+    Estimation of spectral mismatch for BIPV application in vertical facades.


Suggested change

Estimation of spectral mismatch for BIPV application in vertical facades.

Estimate the spectral mismatch for BIPV application in vertical facades.

I think the imperative form is standard practice for the summary line

cwhanse · 2025-06-30T21:57:26Z

pvlib/spectrum/mismatch.py

+        One of the following PV technology strings from [1]_:
+
+        * ``'cdte'`` - anonymous CdTe module.
+        * ``'monosi'`` - anonymous sc-si module.


Suggested change

* ``'monosi'`` - anonymous sc-si module.

* ``'monosi'`` - anonymous sc-si module.

What is "sc-si"? Is this a typo and should be "monocrystalline Si"?

cwhanse · 2025-06-30T21:58:15Z

pvlib/spectrum/mismatch.py

+        user-defined coefficients, if not using one of the default coefficient
+        set via the ``module_type`` parameter.


Suggested change

user-defined coefficients, if not using one of the default coefficient

set via the ``module_type`` parameter.

user-defined coefficients, if not using one of the coefficient

sets via the ``module_type`` parameter.

cwhanse · 2025-06-30T22:10:56Z

pvlib/spectrum/mismatch.py

+    airmass_absolute : numeric
+        absolute (pressure-adjusted) airmass. [unitless]
+    aod500 : numeric
+        atmospheric aerosol optical depth at 500 nm. [unitless]
+    aoi : numeric
+        angle of incidence. [degrees]


For aoi, I think the definition here should be angle of incidence on the vertical surface, and maybe we don't link to the generic aoi term.

cwhanse · 2025-06-30T22:14:55Z

pvlib/spectrum/mismatch.py

+    if module_type is not None and coefficients is not None:
+        raise ValueError('Only one of `module_type` and `coefficients` should '
+                         'be provided')
+    am_aoi = pvlib.atmosphere.get_relative_airmass(aoi)


Is it correct that aoi = 90 - zenith? I think so, because the surface is assumed to be vertical. If that's the case, then I think requesting zenith rather than aoi as input would be significantly easier for a user to understand.

Add polo-smm

3363ace

Add the polo spectral model for BIPV facades

AdamRJensen added the enhancement label Jun 25, 2025

AdamRJensen reviewed Jun 25, 2025

View reviewed changes

Apply suggestions from code review

ceba758

Co-authored-by: Adam R. Jensen <[email protected]>

jesuspolo added 2 commits June 25, 2025 11:53

Update mismatch.py

36c9b43

Update mismatch.py

eaa90b4

AdamRJensen reviewed Jun 25, 2025

View reviewed changes

Update mismatch.py

794ed98

echedey-ls added this to the v0.13.1 milestone Jun 25, 2025

echedey-ls reviewed Jun 25, 2025

View reviewed changes

Update mismatch.py

7926a3d

echedey-ls reviewed Jun 25, 2025

View reviewed changes

jesuspolo added a commit to jesuspolo/pvlib-python that referenced this pull request Jun 27, 2025

Update test_mismatch.py

3493f79

Add test of use of spectral_factor_polo fuction (pull pvlib#2491)

RDaxini reviewed Jun 30, 2025

View reviewed changes

cwhanse reviewed Jun 30, 2025

View reviewed changes

	Estimation of spectral mismatch for BIPV application in vertical facades.
	Estimate the spectral mismatch for BIPV application in vertical facades.

	* ``'monosi'`` - anonymous sc-si module.
	* ``'monosi'`` - anonymous sc-si module.

		user-defined coefficients, if not using one of the default coefficient
		set via the ``module_type`` parameter.

Add polo-smm #2491

Are you sure you want to change the base?

Add polo-smm #2491

Uh oh!

Conversation

jesuspolo commented Jun 25, 2025 • edited by AdamRJensen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AdamRJensen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AdamRJensen commented Jun 25, 2025

Uh oh!

jesuspolo commented Jun 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

echedey-ls left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RDaxini left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RDaxini Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jesuspolo commented Jun 25, 2025 •

edited by AdamRJensen

Loading

RDaxini left a comment •

edited

Loading

RDaxini Jun 30, 2025 •

edited

Loading