@@ -294,13 +294,20 @@ def total_irrad(surface_tilt, surface_azimuth,
294294 model = 'isotropic' ,
295295 model_perez = 'allsitescomposite1990' , ** kwargs ):
296296 r"""
297- Determine diffuse irradiance from the sky on a tilted surface.
297+ Determine total in-plane irradiance and its beam, sky diffuse and ground
298+ reflected components, using the specified sky diffuse irradiance model.
298299
299300 .. math::
300301
301- I_{tot} = I_{beam} + I_{sky} + I_{ground}
302+ I_{tot} = I_{beam} + I_{sky diffuse } + I_{ground}
302303
303- See the transposition function documentation for details.
304+ Sky diffuse models include:
305+ * isotropic (default)
306+ * klucher
307+ * haydavies
308+ * reindl
309+ * king
310+ * perez
304311
305312 Parameters
306313 ----------
@@ -333,8 +340,8 @@ def total_irrad(surface_tilt, surface_azimuth,
333340
334341 Returns
335342 -------
336- irradiance : OrderedDict or DataFrame
337- Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
343+ total_irrad : OrderedDict or DataFrame
344+ Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
338345 'poa_sky_diffuse', 'poa_ground_diffuse'``.
339346 """
340347
@@ -1326,8 +1333,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
13261333 Determine DNI from GHI using the DIRINDEX model, which is a modification of
13271334 the DIRINT model with information from a clear sky model.
13281335
1329- DIRINDEX [1] improves upon the DIRINT model by taking into account turbidity
1330- when used with the Ineichen clear sky model results.
1336+ DIRINDEX [1] improves upon the DIRINT model by taking into account
1337+ turbidity when used with the Ineichen clear sky model results.
13311338
13321339 Parameters
13331340 ----------
@@ -1389,7 +1396,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
13891396 use_delta_kt_prime = use_delta_kt_prime ,
13901397 temp_dew = temp_dew )
13911398
1392- dni_dirint_clearsky = dirint (ghi_clearsky , zenith , times , pressure = pressure ,
1399+ dni_dirint_clearsky = dirint (ghi_clearsky , zenith , times ,
1400+ pressure = pressure ,
13931401 use_delta_kt_prime = use_delta_kt_prime ,
13941402 temp_dew = temp_dew )
13951403
0 commit comments