From bf5e3cf6406748ffde42daf7525c4eaf861a37da Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Mon, 12 Feb 2018 14:13:42 -0700 Subject: [PATCH 1/3] Fix total_irrad docstring --- pvlib/irradiance.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 3b782465ff..9f90eda414 100755 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -294,13 +294,20 @@ def total_irrad(surface_tilt, surface_azimuth, model='isotropic', model_perez='allsitescomposite1990', **kwargs): r""" - Determine diffuse irradiance from the sky on a tilted surface. + Determine total in-plane irradiance and it's beam, sky diffuse and ground + reflected components, using the specified sky diffuse irradiance model. .. math:: - I_{tot} = I_{beam} + I_{sky} + I_{ground} + I_{tot} = I_{beam} + I_{sky diffuse} + I_{ground} - See the transposition function documentation for details. + Sky diffuse models include: + * isotropic (default) + * klucher + * haydavies + * reindl + * king + * perez Parameters ---------- @@ -333,7 +340,7 @@ def total_irrad(surface_tilt, surface_azimuth, Returns ------- - irradiance : OrderedDict or DataFrame + total_irrad : OrderedDict or DataFrame Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse', 'poa_sky_diffuse', 'poa_ground_diffuse'``. """ From beadc8d2bdd2cfff377fee1f0e9b83372f3c05ab Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Mon, 12 Feb 2018 14:32:04 -0700 Subject: [PATCH 2/3] Correct formatting in irradiance.py; update whatsnew.rst --- docs/sphinx/source/whatsnew/v0.5.2.rst | 1 + pvlib/irradiance.py | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.5.2.rst b/docs/sphinx/source/whatsnew/v0.5.2.rst index a0637ed17e..b02691448f 100644 --- a/docs/sphinx/source/whatsnew/v0.5.2.rst +++ b/docs/sphinx/source/whatsnew/v0.5.2.rst @@ -16,6 +16,7 @@ Bug fixes * fixed redeclaration of test_simplified_solis_series_elevation (:issue:`387`) * physicaliam now returns a Series if called with a Series as an argument. (:issue:`397`) +* corrected docstring for irradiance.total_irrad (:issue: '423') Documentation ~~~~~~~~~~~~~ diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 9f90eda414..fb0dfe64e5 100755 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -341,7 +341,7 @@ def total_irrad(surface_tilt, surface_azimuth, Returns ------- total_irrad : OrderedDict or DataFrame - Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse', + Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse', 'poa_sky_diffuse', 'poa_ground_diffuse'``. """ @@ -1333,8 +1333,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325., Determine DNI from GHI using the DIRINDEX model, which is a modification of the DIRINT model with information from a clear sky model. - DIRINDEX [1] improves upon the DIRINT model by taking into account turbidity - when used with the Ineichen clear sky model results. + DIRINDEX [1] improves upon the DIRINT model by taking into account + turbidity when used with the Ineichen clear sky model results. Parameters ---------- @@ -1396,7 +1396,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325., use_delta_kt_prime=use_delta_kt_prime, temp_dew=temp_dew) - dni_dirint_clearsky = dirint(ghi_clearsky, zenith, times, pressure=pressure, + dni_dirint_clearsky = dirint(ghi_clearsky, zenith, times, + pressure=pressure, use_delta_kt_prime=use_delta_kt_prime, temp_dew=temp_dew) From fcc7fd564d4fd126caea6fc14af0bc8d9ac86397 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Tue, 13 Feb 2018 02:43:51 +0000 Subject: [PATCH 3/3] 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 fb0dfe64e5..49b51a9088 100755 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -294,7 +294,7 @@ def total_irrad(surface_tilt, surface_azimuth, model='isotropic', model_perez='allsitescomposite1990', **kwargs): r""" - Determine total in-plane irradiance and it's beam, sky diffuse and ground + Determine total in-plane irradiance and its beam, sky diffuse and ground reflected components, using the specified sky diffuse irradiance model. .. math::