Skip to content

Commit 94c3fc5

Browse files
authored
Update irradiance.klucher docs (#2192)
* 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 * Update irradiance.py update variable names (I_d0 to DHI and add definition of theta as aoi) * Update irradiance.py add doi * Update irradiance.py wording in definition of F' * Update irradiance.py * Update irradiance.py \theta->\beta reinstate Loutzenhiser reference * Update irradiance.py add doi to * Update irradiance.py * Update irradiance.py add units to returns statement * typo * Update v0.11.1.rst * Update v0.11.1.rst * update model description * whatsnew, update and merge entries * whatsnew (missing word) * move references (klucher and haydavies) moved references from first line to notes section
1 parent f4fa92e commit 94c3fc5

File tree

2 files changed

+47
-38
lines changed

2 files changed

+47
-38
lines changed

docs/sphinx/source/whatsnew/v0.11.1.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,10 @@ Documentation
7575
* Fixed examples in :py:func:`pvlib.shading.shaded_fraction1d`. (:pull:`#2215`)
7676

7777
* Removed unused "times" input from dni_et() function (:issue:`2105`)
78-
* Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable
79-
definitions and a new "notes" section (:issue:`2183`, :pull:`2191`)
80-
78+
* Updated model description, added equation variable definitions, and created a
79+
new "notes" section in :py:func:`pvlib.irradiance.haydavies` and
80+
:py:func:`pvlib.irradiance.klucher` (:issue:`2183`, :pull:`2191`,
81+
:pull:`2192`)
8182
* Split the contributing page into several pages (:issue:`2210`, :pull:`2219`)
8283

8384
Requirements

pvlib/irradiance.py

Lines changed: 43 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -630,66 +630,74 @@ def klucher(surface_tilt, surface_azimuth, dhi, ghi, solar_zenith,
630630
solar_azimuth):
631631
r'''
632632
Determine diffuse irradiance from the sky on a tilted surface
633-
using Klucher's 1979 model
634-
635-
.. math::
636-
637-
I_{d} = DHI \frac{1 + \cos\beta}{2} (1 + F' \sin^3(\beta/2))
638-
(1 + F' \cos^2\theta\sin^3\theta_z)
639-
640-
where
641-
642-
.. math::
643-
644-
F' = 1 - (I_{d0} / GHI)^2
645-
646-
Klucher's 1979 model determines the diffuse irradiance from the sky
647-
(ground reflected irradiance is not included in this algorithm) on a
648-
tilted surface using the surface tilt angle, surface azimuth angle,
649-
diffuse horizontal irradiance, direct normal irradiance, global
650-
horizontal irradiance, extraterrestrial irradiance, sun zenith
651-
angle, and sun azimuth angle.
633+
using the Klucher (1979) model.
652634
653635
Parameters
654636
----------
655637
surface_tilt : numeric
656-
Surface tilt angles in decimal degrees. surface_tilt must be >=0
638+
Surface tilt angles in decimal degrees. ``surface_tilt`` must be >=0
657639
and <=180. The tilt angle is defined as degrees from horizontal
658640
(e.g. surface facing up = 0, surface facing horizon = 90)
659641
660642
surface_azimuth : numeric
661-
Surface azimuth angles in decimal degrees. surface_azimuth must
643+
Surface azimuth angles in decimal degrees. ``surface_azimuth`` must
662644
be >=0 and <=360. The Azimuth convention is defined as degrees
663645
east of north (e.g. North = 0, South=180 East = 90, West = 270).
664646
665647
dhi : numeric
666-
Diffuse horizontal irradiance. [Wm⁻²] DHI must be >=0.
648+
Diffuse horizontal irradiance, must be >=0. [Wm⁻²]
667649
668650
ghi : numeric
669-
Global irradiance. [Wm⁻²] DNI must be >=0.
651+
Global horizontal irradiance, must be >=0. [Wm⁻²]
670652
671653
solar_zenith : numeric
672654
Apparent (refraction-corrected) zenith angles in decimal
673-
degrees. solar_zenith must be >=0 and <=180.
655+
degrees. ``solar_zenith`` must be >=0 and <=180.
674656
675657
solar_azimuth : numeric
676-
Sun azimuth angles in decimal degrees. solar_azimuth must be >=0
658+
Sun azimuth angles in decimal degrees. ``solar_azimuth`` must be >=0
677659
and <=360. The Azimuth convention is defined as degrees east of
678660
north (e.g. North = 0, East = 90, West = 270).
679661
680662
Returns
681663
-------
682664
diffuse : numeric
683-
The sky diffuse component of the solar radiation.
665+
The sky diffuse component of the solar radiation. [Wm⁻²]
666+
667+
Notes
668+
-----
669+
The Klucher (1979) model [1]_ [2]_ determines the diffuse irradiance
670+
from the sky (ground reflected irradiance is not included in this
671+
algorithm) on a tilted surface using the surface tilt angle, surface
672+
azimuth angle, diffuse horizontal irradiance, global horizontal irradiance,
673+
sun zenith angle, and sun azimuth angle. The expression for the sky diffuse
674+
irradiance, :math:`I_d`, is as follows:
675+
676+
.. math::
677+
678+
I_{d} = DHI \frac{1 + \cos\beta}{2} (1 + F' \sin^3(\beta/2))
679+
(1 + F' \cos^2\theta\sin^3\theta_z).
680+
681+
DHI is the diffuse horizontal irradiance, :math:`\beta` is the surface
682+
tilt angle, :math:`\theta_z` is the solar zenith angle, and :math:`\theta`
683+
is the angle of incidence. :math:`F'` is a modulating function to account
684+
for when the sky changes from clear to overcast, and is defined as follows:
685+
686+
.. math::
687+
688+
F' = 1 - (DHI / GHI)^2,
689+
690+
where GHI is the global horiztonal irradiance.
684691
685692
References
686693
----------
687-
.. [1] Loutzenhiser P.G. et. al. "Empirical validation of models to compute
688-
solar irradiance on inclined surfaces for building energy simulation"
689-
2007, Solar Energy vol. 81. pp. 254-267
690-
691-
.. [2] Klucher, T.M., 1979. Evaluation of models to predict insolation on
692-
tilted surfaces. Solar Energy 23 (2), 111-114.
694+
.. [1] Klucher, T. M. "Evaluation of models to predict insolation on
695+
tilted surfaces" 1979, Solar Energy vol. 23 (2), pp. 111-114
696+
:doi:`10.1016/0038-092X(79)90110-5`
697+
.. [2] Loutzenhiser P. G. et al. "Empirical validation of models to
698+
compute solar irradiance on inclined surfaces for building energy
699+
simulation" 2007, Solar Energy vol. 81. pp. 254-267
700+
:doi:`10.1016/j.solener.2006.03.009`
693701
'''
694702

695703
# zenith angle with respect to panel normal.
@@ -721,7 +729,7 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
721729
return_components=False):
722730
r'''
723731
Determine diffuse irradiance from the sky on a tilted surface using the
724-
Hay and Davies (1980) model [1]_ [2]_.
732+
Hay and Davies (1980) model.
725733
726734
The Hay and Davies model determines the diffuse irradiance from
727735
the sky (ground reflected irradiance is not included in this
@@ -790,8 +798,8 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
790798
791799
Notes
792800
------
793-
In the Hay and Davies (1980) model, sky diffuse irradiance, :math:`I_d`,
794-
is as follows:
801+
In the Hay and Davies (1980) model [1]_ [2]_, sky diffuse irradiance,
802+
:math:`I_d`, is as follows:
795803
796804
.. math::
797805
I_{d} = DHI \left( A\cdot R_b + (1 - A) \left(\frac{

0 commit comments

Comments
 (0)