Skip to content

Fix total_irrad docstring #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwhanse merged 1 commit into from
Feb 12, 2018
Merged

Fix total_irrad docstring #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down Expand Up @@ -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'``.
"""
Expand Down