Skip to content

Commit 5d5afde

Browse files
authored
Merge pull request #1 from cwhanse/total_irrad-docstring
Fix total_irrad docstring
2 parents b419720 + bf5e3cf commit 5d5afde

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

pvlib/irradiance.py

+11-4
Original file line numberDiff line numberDiff line change
@@ -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 it's 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,7 +340,7 @@ def total_irrad(surface_tilt, surface_azimuth,
333340
334341
Returns
335342
-------
336-
irradiance : OrderedDict or DataFrame
343+
total_irrad : OrderedDict or DataFrame
337344
Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
338345
'poa_sky_diffuse', 'poa_ground_diffuse'``.
339346
"""

0 commit comments

Comments
 (0)