From 4a4ec5805062f4134f2561bcbf18b0e9ceb66cd0 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 30 Aug 2024 12:49:40 +0100 Subject: [PATCH 01/16] Update irradiance.py move eqn and add description and variables definition to a new notes section update references redefine surface tilt for consistency with #2191 --- pvlib/irradiance.py | 62 +++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 435c318562..e69069f95d 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -630,50 +630,32 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, solar_azimuth): r''' Determine diffuse irradiance from the sky on a tilted surface - using Klucher's 1979 model - - .. math:: - - I_{d} = DHI \frac{1 + \cos\beta}{2} (1 + F' \sin^3(\beta/2)) - (1 + F' \cos^2\theta\sin^3\theta_z) - - where - - .. math:: - - F' = 1 - (I_{d0} / GHI)^2 - - Klucher's 1979 model determines the diffuse irradiance from the sky - (ground reflected irradiance is not included in this algorithm) on a - tilted surface using the surface tilt angle, surface azimuth angle, - diffuse horizontal irradiance, direct normal irradiance, global - horizontal irradiance, extraterrestrial irradiance, sun zenith - angle, and sun azimuth angle. + using the Klucher (1979) model [1]_. Parameters ---------- surface_tilt : numeric - Surface tilt angles in decimal degrees. surface_tilt must be >=0 + Surface tilt angles in decimal degrees. ``surface_tilt`` must be >=0 and <=180. The tilt angle is defined as degrees from horizontal (e.g. surface facing up = 0, surface facing horizon = 90) surface_azimuth : numeric - Surface azimuth angles in decimal degrees. surface_azimuth must + Surface azimuth angles in decimal degrees. ``surface_azimuth`` must be >=0 and <=360. The Azimuth convention is defined as degrees east of north (e.g. North = 0, South=180 East = 90, West = 270). dhi : numeric - Diffuse horizontal irradiance in W/m^2. DHI must be >=0. + Diffuse horizontal irradiance in W/m^2. ``dhi`` must be >=0. ghi : numeric - Global irradiance in W/m^2. DNI must be >=0. + Global irradiance in W/m^2. ``ghi`` must be >=0. solar_zenith : numeric Apparent (refraction-corrected) zenith angles in decimal - degrees. solar_zenith must be >=0 and <=180. + degrees. ``solar_zenith`` must be >=0 and <=180. solar_azimuth : numeric - Sun azimuth angles in decimal degrees. solar_azimuth must be >=0 + Sun azimuth angles in decimal degrees. ``solar_azimuth`` must be >=0 and <=360. The Azimuth convention is defined as degrees east of north (e.g. North = 0, East = 90, West = 270). @@ -682,13 +664,33 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, diffuse : numeric The sky diffuse component of the solar radiation. + Notes + ----- + The Klucher (1979) model determines the diffuse irradiance + from the sky (ground reflected irradiance is not included in this + algorithm) on a tilted surface using the surface tilt angle, surface + azimuth angle, diffuse horizontal irradiance, direct normal irradiance, + global mhorizontal irradiance, extraterrestrial irradiance, sun zenith + angle, and sun azimuth angle. The expression for the diffuse irradiance, + :math:`I_d`, is as follows: + + .. math:: + + I_{d} = DHI \frac{1 + \cos\theta_T}{2} (1 + F' \sin^3(\theta_T/2)) + (1 + F' \cos^2\theta\sin^3\theta_z). + + DHI is the diffuse horizontal irradiance, :math:`\theta_T` is the surface + tilt angle, :math:`\theta_z` is the solar zenith angle. :math:`F'` is a + modulating function to account for when skies change from clear to + overcast, and is defined as follows: + + .. math:: + + F' = 1 - (I_{d0} / GHI)^2 + References ---------- - .. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute - solar irradiance on inclined surfaces for building energy simulation" - 2007, Solar Energy vol. 81. pp. 254-267 - - .. [2] Klucher, T.M., 1979. Evaluation of models to predict insolation on + .. [1] Klucher, T.M., 1979. Evaluation of models to predict insolation on tilted surfaces. Solar Energy 23 (2), 111-114. ''' From 8ccfdcedc2c8f8667b0a12f15751b8f6bfaad58a Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 30 Aug 2024 13:19:12 +0100 Subject: [PATCH 02/16] Update irradiance.py update variable names (I_d0 to DHI and add definition of theta as aoi) --- pvlib/irradiance.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index e69069f95d..88f0a99b56 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -670,7 +670,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, from the sky (ground reflected irradiance is not included in this algorithm) on a tilted surface using the surface tilt angle, surface azimuth angle, diffuse horizontal irradiance, direct normal irradiance, - global mhorizontal irradiance, extraterrestrial irradiance, sun zenith + global horizontal irradiance, extraterrestrial irradiance, sun zenith angle, and sun azimuth angle. The expression for the diffuse irradiance, :math:`I_d`, is as follows: @@ -680,13 +680,15 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, (1 + F' \cos^2\theta\sin^3\theta_z). DHI is the diffuse horizontal irradiance, :math:`\theta_T` is the surface - tilt angle, :math:`\theta_z` is the solar zenith angle. :math:`F'` is a - modulating function to account for when skies change from clear to - overcast, and is defined as follows: + tilt angle, :math:`\theta_z` is the solar zenith angle, and :math:`\theta` + is the angle of incidence. :math:`F'` is a modulating function to account + for when skies change from clear to overcast, and is defined as follows: .. math:: - F' = 1 - (I_{d0} / GHI)^2 + F' = 1 - (DHI / GHI)^2, + + where GHI is the global horiztonal irradiance. References ---------- From e43c541212879b8a9d6ac097775a56d877a67597 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 30 Aug 2024 13:32:54 +0100 Subject: [PATCH 03/16] Update irradiance.py add doi --- pvlib/irradiance.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 88f0a99b56..12913a4b68 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -694,6 +694,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, ---------- .. [1] Klucher, T.M., 1979. Evaluation of models to predict insolation on tilted surfaces. Solar Energy 23 (2), 111-114. + :doi:`10.1016/0038-092X(79)90110-5` ''' # zenith angle with respect to panel normal. From a89a47f065f623c6d7db43a5374b3e1308e3d11d Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 30 Aug 2024 14:09:08 +0100 Subject: [PATCH 04/16] Update irradiance.py wording in definition of F' --- pvlib/irradiance.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 12913a4b68..db41752dff 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -682,7 +682,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, DHI is the diffuse horizontal irradiance, :math:`\theta_T` is the surface tilt angle, :math:`\theta_z` is the solar zenith angle, and :math:`\theta` is the angle of incidence. :math:`F'` is a modulating function to account - for when skies change from clear to overcast, and is defined as follows: + for when the sky changes from clear to overcast, and is defined as follows: .. math:: From 6ef2416e46ef0566c3fb67fc044833e1131bba1d Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 30 Aug 2024 14:21:56 +0100 Subject: [PATCH 05/16] Update irradiance.py --- pvlib/irradiance.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index db41752dff..db33afd7a9 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -692,7 +692,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, References ---------- - .. [1] Klucher, T.M., 1979. Evaluation of models to predict insolation on + .. [1] Klucher, T. M., 1979. Evaluation of models to predict insolation on tilted surfaces. Solar Energy 23 (2), 111-114. :doi:`10.1016/0038-092X(79)90110-5` ''' From 3b9be696feabf4ab0de1369901e24029e254a823 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 18 Sep 2024 13:16:58 +0100 Subject: [PATCH 06/16] Update irradiance.py \theta->\beta reinstate Loutzenhiser reference --- pvlib/irradiance.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 47998dcb40..4f237b8eae 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -630,7 +630,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, solar_azimuth): r''' Determine diffuse irradiance from the sky on a tilted surface - using the Klucher (1979) model [1]_. + using the Klucher (1979) model [1]_[2]_. Parameters ---------- @@ -695,6 +695,9 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, .. [1] Klucher, T. M., 1979. Evaluation of models to predict insolation on tilted surfaces. Solar Energy 23 (2), 111-114. :doi:`10.1016/0038-092X(79)90110-5` + .. [2] Loutzenhiser P.G. et. al. "Empirical validation of models to + compute solar irradiance on inclined surfaces for building energy + simulation" 2007, Solar Energy vol. 81. pp. 254-267 ''' # zenith angle with respect to panel normal. @@ -1260,8 +1263,8 @@ def _f(i, j, zeta): [+0.328, +0.471, -0.216, +0.069, -0.105, -0.028], [+0.557, +0.241, -0.300, +0.086, -0.085, -0.012], [+0.861, -0.323, -0.355, +0.240, -0.467, -0.008], - [ 1.212, -1.239, -0.444, +0.305, -0.797, +0.047], - [ 1.099, -1.847, -0.365, +0.275, -1.132, +0.124], + [1.212, -1.239, -0.444, +0.305, -0.797, +0.047], + [1.099, -1.847, -0.365, +0.275, -1.132, +0.124], [+0.544, +0.157, -0.213, +0.118, -1.455, +0.292], [+0.544, +0.157, -0.213, +0.118, -1.455, +0.292], [+0.000, +0.000, +0.000, +0.000, +0.000, +0.000], From d45277ebe7247427244e64cb190075a506aaf7cf Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 18 Sep 2024 13:18:27 +0100 Subject: [PATCH 07/16] Update irradiance.py add doi to --- pvlib/irradiance.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 4f237b8eae..ae8e498d19 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -630,7 +630,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, solar_azimuth): r''' Determine diffuse irradiance from the sky on a tilted surface - using the Klucher (1979) model [1]_[2]_. + using the Klucher (1979) model [1]_ [2]_. Parameters ---------- @@ -676,10 +676,10 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, .. math:: - I_{d} = DHI \frac{1 + \cos\theta_T}{2} (1 + F' \sin^3(\theta_T/2)) + I_{d} = DHI \frac{1 + \cos\beta}{2} (1 + F' \sin^3(\beta/2)) (1 + F' \cos^2\theta\sin^3\theta_z). - DHI is the diffuse horizontal irradiance, :math:`\theta_T` is the surface + DHI is the diffuse horizontal irradiance, :math:`\beta` is the surface tilt angle, :math:`\theta_z` is the solar zenith angle, and :math:`\theta` is the angle of incidence. :math:`F'` is a modulating function to account for when the sky changes from clear to overcast, and is defined as follows: @@ -698,6 +698,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, .. [2] Loutzenhiser P.G. et. al. "Empirical validation of models to compute solar irradiance on inclined surfaces for building energy simulation" 2007, Solar Energy vol. 81. pp. 254-267 + :doi:`10.1016/j.solener.2006.03.009` ''' # zenith angle with respect to panel normal. From b2d671a6555e734489e89d56cf36fc8833a0120a Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:32:29 +0100 Subject: [PATCH 08/16] Update irradiance.py --- pvlib/irradiance.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 087a419653..9553ca102f 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -645,10 +645,10 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, east of north (e.g. North = 0, South=180 East = 90, West = 270). dhi : numeric - Diffuse horizontal irradiance. [Wm⁻²] DHI must be >=0. + Diffuse horizontal irradiancem, must be >=0. [Wm⁻²] ghi : numeric - Global irradiance. [Wm⁻²] DNI must be >=0. + Global horizontal irradiance, must be >=0. [Wm⁻²] solar_zenith : numeric Apparent (refraction-corrected) zenith angles in decimal @@ -692,10 +692,10 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, References ---------- - .. [1] Klucher, T. M., 1979. Evaluation of models to predict insolation on - tilted surfaces. Solar Energy 23 (2), 111-114. + .. [1] Klucher, T. M. "Evaluation of models to predict insolation on + tilted surfaces" 1979, Solar Energy vol. 23 (2), pp. 111-114 :doi:`10.1016/0038-092X(79)90110-5` - .. [2] Loutzenhiser P.G. et. al. "Empirical validation of models to + .. [2] Loutzenhiser P. G. et al. "Empirical validation of models to compute solar irradiance on inclined surfaces for building energy simulation" 2007, Solar Energy vol. 81. pp. 254-267 :doi:`10.1016/j.solener.2006.03.009` From 7c6c8cf36c97fa4e9664dac81d83dfdb23bf6aa6 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:50:12 +0100 Subject: [PATCH 09/16] Update irradiance.py add units to returns statement --- pvlib/irradiance.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 9553ca102f..e5bf44c8b1 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -662,7 +662,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, Returns ------- diffuse : numeric - The sky diffuse component of the solar radiation. + The sky diffuse component of the solar radiation. [Wm⁻²] Notes ----- From d78497807999f56fb93b9577f5aae0bd88a9fdcc Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:00:00 +0100 Subject: [PATCH 10/16] typo --- pvlib/irradiance.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index e5bf44c8b1..c49fa6763c 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -645,7 +645,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, east of north (e.g. North = 0, South=180 East = 90, West = 270). dhi : numeric - Diffuse horizontal irradiancem, must be >=0. [Wm⁻²] + Diffuse horizontal irradiance, must be >=0. [Wm⁻²] ghi : numeric Global horizontal irradiance, must be >=0. [Wm⁻²] From 105042a5bac175e19b9ad04cff2f4ed4f6e83b8f Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:09:44 +0100 Subject: [PATCH 11/16] Update v0.11.1.rst --- docs/sphinx/source/whatsnew/v0.11.1.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.11.1.rst b/docs/sphinx/source/whatsnew/v0.11.1.rst index 4e68b2c920..509343b3b3 100644 --- a/docs/sphinx/source/whatsnew/v0.11.1.rst +++ b/docs/sphinx/source/whatsnew/v0.11.1.rst @@ -74,7 +74,8 @@ Documentation * Removed unused "times" input from dni_et() function (:issue:`2105`) * Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable definitions and a new "notes" section (:issue:`2183`, :pull:`2191`) - +* Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable + definitions and a new "notes" section (:issue:`2183`, :pull:`2192`) * Split the contributing page into several pages (:issue:`2210`, :pull:`2219`) Requirements From f59eb7769b45e44624d1199d694cc18b7260cbb8 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:12:14 +0100 Subject: [PATCH 12/16] Update v0.11.1.rst --- docs/sphinx/source/whatsnew/v0.11.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.11.1.rst b/docs/sphinx/source/whatsnew/v0.11.1.rst index 509343b3b3..ec9170fe4f 100644 --- a/docs/sphinx/source/whatsnew/v0.11.1.rst +++ b/docs/sphinx/source/whatsnew/v0.11.1.rst @@ -74,7 +74,7 @@ Documentation * Removed unused "times" input from dni_et() function (:issue:`2105`) * Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable definitions and a new "notes" section (:issue:`2183`, :pull:`2191`) -* Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable +* Updated :py:func:`pvlib.irradiance.klucher` to include equation variable definitions and a new "notes" section (:issue:`2183`, :pull:`2192`) * Split the contributing page into several pages (:issue:`2210`, :pull:`2219`) From 068a7104f46866ba08b33465d85fba3273dfb480 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:57:08 +0100 Subject: [PATCH 13/16] update model description --- pvlib/irradiance.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index c49fa6763c..be8d103493 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -669,10 +669,9 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, The Klucher (1979) model determines the diffuse irradiance from the sky (ground reflected irradiance is not included in this algorithm) on a tilted surface using the surface tilt angle, surface - azimuth angle, diffuse horizontal irradiance, direct normal irradiance, - global horizontal irradiance, extraterrestrial irradiance, sun zenith - angle, and sun azimuth angle. The expression for the diffuse irradiance, - :math:`I_d`, is as follows: + azimuth angle, diffuse horizontal irradiance, global horizontal irradiance, + sun zenith angle, and sun azimuth angle. The expression for the sky diffuse + irradiance, :math:`I_d`, is as follows: .. math:: From 016f8d9ebdc6950c03d22f55dae37b7619bf2c9f Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:57:31 +0100 Subject: [PATCH 14/16] whatsnew, update and merge entries --- docs/sphinx/source/whatsnew/v0.11.1.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.11.1.rst b/docs/sphinx/source/whatsnew/v0.11.1.rst index ec9170fe4f..9849520ec3 100644 --- a/docs/sphinx/source/whatsnew/v0.11.1.rst +++ b/docs/sphinx/source/whatsnew/v0.11.1.rst @@ -72,10 +72,10 @@ Documentation * Fixed examples in :py:func:`pvlib.shading.shaded_fraction1d`. (:pull:`#2215`) * Removed unused "times" input from dni_et() function (:issue:`2105`) -* Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable - definitions and a new "notes" section (:issue:`2183`, :pull:`2191`) -* Updated :py:func:`pvlib.irradiance.klucher` to include equation variable - definitions and a new "notes" section (:issue:`2183`, :pull:`2192`) +* Updated model description, added equation variable, and created a new "notes" + section in :py:func:`pvlib.irradiance.haydavies` and + :py:func:`pvlib.irradiance.klucher` (:issue:`2183`, :pull:`2191`, + :pull:`2192`) * Split the contributing page into several pages (:issue:`2210`, :pull:`2219`) Requirements From 529596d3b9c56443c1f5fb3129d5c8a0c1ca6de6 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:59:45 +0100 Subject: [PATCH 15/16] whatsnew (missing word) --- docs/sphinx/source/whatsnew/v0.11.1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.11.1.rst b/docs/sphinx/source/whatsnew/v0.11.1.rst index 9849520ec3..def7cdc714 100644 --- a/docs/sphinx/source/whatsnew/v0.11.1.rst +++ b/docs/sphinx/source/whatsnew/v0.11.1.rst @@ -72,8 +72,8 @@ Documentation * Fixed examples in :py:func:`pvlib.shading.shaded_fraction1d`. (:pull:`#2215`) * Removed unused "times" input from dni_et() function (:issue:`2105`) -* Updated model description, added equation variable, and created a new "notes" - section in :py:func:`pvlib.irradiance.haydavies` and +* Updated model description, added equation variable definitions, and created a + new "notes" section in :py:func:`pvlib.irradiance.haydavies` and :py:func:`pvlib.irradiance.klucher` (:issue:`2183`, :pull:`2191`, :pull:`2192`) * Split the contributing page into several pages (:issue:`2210`, :pull:`2219`) From 8f26c27dc54b4be360c15a058b66c0fff3d77bd0 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 25 Sep 2024 18:54:01 +0100 Subject: [PATCH 16/16] move references (klucher and haydavies) moved references from first line to notes section --- pvlib/irradiance.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index be8d103493..db62439772 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -630,7 +630,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, solar_azimuth): r''' Determine diffuse irradiance from the sky on a tilted surface - using the Klucher (1979) model [1]_ [2]_. + using the Klucher (1979) model. Parameters ---------- @@ -666,7 +666,7 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith, Notes ----- - The Klucher (1979) model determines the diffuse irradiance + The Klucher (1979) model [1]_ [2]_ determines the diffuse irradiance from the sky (ground reflected irradiance is not included in this algorithm) on a tilted surface using the surface tilt angle, surface azimuth angle, diffuse horizontal irradiance, global horizontal irradiance, @@ -729,7 +729,7 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra, return_components=False): r''' Determine diffuse irradiance from the sky on a tilted surface using the - Hay and Davies (1980) model [1]_ [2]_. + Hay and Davies (1980) model. The Hay and Davies model determines the diffuse irradiance from the sky (ground reflected irradiance is not included in this @@ -798,8 +798,8 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra, Notes ------ - In the Hay and Davies (1980) model, sky diffuse irradiance, :math:`I_d`, - is as follows: + In the Hay and Davies (1980) model [1]_ [2]_, sky diffuse irradiance, + :math:`I_d`, is as follows: .. math:: I_{d} = DHI \left( A\cdot R_b + (1 - A) \left(\frac{