diff --git a/docs/sphinx/source/whatsnew/v0.16.2.rst b/docs/sphinx/source/whatsnew/v0.16.2.rst index fb3ff54f76..c21bf17d4f 100644 --- a/docs/sphinx/source/whatsnew/v0.16.2.rst +++ b/docs/sphinx/source/whatsnew/v0.16.2.rst @@ -52,6 +52,9 @@ Documentation * Note deprecation of ``king`` model in :py:func:`~pvlib.irradiance.get_total_irradiance` and :py:func:`~pvlib.irradiance.get_sky_diffuse` docstrings. (:issue:`2897`, :pull:`2904`) +* Document the effect of ``n_pvrows`` on edge effects and runtime in + :py:func:`pvlib.bifacial.pvfactors.pvfactors_timeseries`. + (:issue:`1398`, :pull:`2954`) Testing @@ -84,3 +87,4 @@ Contributors * :ghuser:`xiajiahang` * Jakub Krasuski (:ghuser:`Blizzeq`) * Dylan Pulver (:ghuser:`dylanpulver`) +* :ghuser:`WPTK` diff --git a/pvlib/bifacial/pvfactors.py b/pvlib/bifacial/pvfactors.py index ec6acfc8d3..791953e49f 100644 --- a/pvlib/bifacial/pvfactors.py +++ b/pvlib/bifacial/pvfactors.py @@ -57,7 +57,12 @@ def pvfactors_timeseries( albedo: float Ground albedo n_pvrows: int, default 3 - Number of PV rows to consider in the PV array + Number of PV rows to consider in the PV array. The model treats rows + as infinite in length but finite in number, so a small ``n_pvrows`` + produces edge effects, such as fully illuminated ground under the + array at low sun elevation, which cause morning and afternoon spikes + in rear irradiance. Increasing ``n_pvrows`` reduces these effects but + significantly increases runtime. index_observed_pvrow: int, default 1 Index of the PV row whose incident irradiance will be returned. Indices of PV rows go from 0 to n_pvrows-1.