From bf5e3cf6406748ffde42daf7525c4eaf861a37da Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Mon, 12 Feb 2018 14:13:42 -0700 Subject: [PATCH] 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'``. """