Skip to content

Commit 0a14b27

Browse files
authored
edit DIRINDEX docstring (#760)
* edit docstring * add hyperlinks
1 parent 0be834c commit 0a14b27

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pvlib/irradiance.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1742,11 +1742,13 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
17421742
use_delta_kt_prime=True, temp_dew=None, min_cos_zenith=0.065,
17431743
max_zenith=87):
17441744
"""
1745-
Determine DNI from GHI using the DIRINDEX model, which is a modification of
1746-
the DIRINT model with information from a clear sky model.
1745+
Determine DNI from GHI using the DIRINDEX model.
17471746
1748-
DIRINDEX [1] improves upon the DIRINT model by taking into account
1749-
turbidity when used with the Ineichen clear sky model results.
1747+
The DIRINDEX model [1] modifies the DIRINT model implemented in
1748+
:py:func:``pvlib.irradiance.dirint`` by taking into account information
1749+
from a clear sky model. It is recommended that ``ghi_clearsky`` be
1750+
calculated using the Ineichen clear sky model
1751+
:py:func:``pvlib.clearsky.ineichen`` with ``perez_enhancement=True``.
17501752
17511753
The pvlib implementation limits the clearness index to 1.
17521754

0 commit comments

Comments
 (0)