From 28f211a6defbee19fe36dda88637add9561acc07 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Fri, 2 Aug 2019 08:49:55 -0600 Subject: [PATCH 1/2] edit docstring --- pvlib/irradiance.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 494d13be5a..9e5d99add2 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -1742,11 +1742,13 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325., use_delta_kt_prime=True, temp_dew=None, min_cos_zenith=0.065, max_zenith=87): """ - Determine DNI from GHI using the DIRINDEX model, which is a modification of - the DIRINT model with information from a clear sky model. + Determine DNI from GHI using the DIRINDEX model. - DIRINDEX [1] improves upon the DIRINT model by taking into account - turbidity when used with the Ineichen clear sky model results. + The DIRINDEX model [1] modifies the DIRINT model implemented in + ``pvlib.irradiance.dirint`` by taking into account information from a + clear sky model. It is recommended that ``ghi_clearsky`` be calculated + using the Ineichen clear sky model ``pvlib.clearsky.ineichen`` with + ``perez_enhancement=True``. The pvlib implementation limits the clearness index to 1. From 5ca5cbb799eafbc6edcc5826f3157dbc7fd86ec9 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Sat, 3 Aug 2019 08:00:32 -0600 Subject: [PATCH 2/2] add hyperlinks --- pvlib/irradiance.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 9e5d99add2..55b45521be 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -1745,10 +1745,10 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325., Determine DNI from GHI using the DIRINDEX model. The DIRINDEX model [1] modifies the DIRINT model implemented in - ``pvlib.irradiance.dirint`` by taking into account information from a - clear sky model. It is recommended that ``ghi_clearsky`` be calculated - using the Ineichen clear sky model ``pvlib.clearsky.ineichen`` with - ``perez_enhancement=True``. + :py:func:``pvlib.irradiance.dirint`` by taking into account information + from a clear sky model. It is recommended that ``ghi_clearsky`` be + calculated using the Ineichen clear sky model + :py:func:``pvlib.clearsky.ineichen`` with ``perez_enhancement=True``. The pvlib implementation limits the clearness index to 1.