Skip to content

Closes #423 total_irrad docstring #425

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
merged 5 commits into from
Feb 13, 2018
Merged

Closes #423 total_irrad docstring #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf5e3cf
Fix total_irrad docstring
cwhanse Feb 12, 2018
5d5afde
Merge pull request #1 from cwhanse/total_irrad-docstring
cwhanse Feb 12, 2018
beadc8d
Correct formatting in irradiance.py; update whatsnew.rst
cwhanse Feb 12, 2018
767a466
Merge pull request #2 from cwhanse/total_irrad-docstring
cwhanse Feb 12, 2018
fcc7fd5
Update irradiance.py
cwhanse Feb 13, 2018
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
1 change: 1 addition & 0 deletions docs/sphinx/source/whatsnew/v0.5.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls change single quotes around #423 to backticks


Documentation
~~~~~~~~~~~~~
Expand Down
24 changes: 16 additions & 8 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 its 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,8 +340,8 @@ def total_irrad(surface_tilt, surface_azimuth,

Returns
-------
irradiance : OrderedDict or DataFrame
Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
total_irrad : OrderedDict or DataFrame
Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
'poa_sky_diffuse', 'poa_ground_diffuse'``.
"""

Expand Down Expand Up @@ -1326,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
----------
Expand Down Expand Up @@ -1389,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)

Expand Down