Skip to content

edit DIRINDEX docstring #760

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 2 commits into from
Aug 6, 2019
Merged

edit DIRINDEX docstring #760

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28f211a
edit docstring
cwhanse Aug 2, 2019
5ca5cbb
add hyperlinks
cwhanse Aug 3, 2019
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
10 changes: 6 additions & 4 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1742,11 +1742,13 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
use_delta_kt_prime=True, temp_dew=None, min_cos_zenith=0.065,
max_zenith=87):
"""
Determine DNI from GHI using the DIRINDEX model, which is a modification of
the DIRINT model with information from a clear sky model.
Determine DNI from GHI using the DIRINDEX model.

DIRINDEX [1] improves upon the DIRINT model by taking into account
turbidity when used with the Ineichen clear sky model results.
The DIRINDEX model [1] modifies the DIRINT model implemented in
``pvlib.irradiance.dirint`` by taking into account information from a
Copy link
Member

@wholmgren wholmgren Aug 2, 2019

Choose a reason for hiding this comment

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

Suggested change
``pvlib.irradiance.dirint`` by taking into account information from a
:py:func:`pvlib.irradiance.dirint` by taking into account information from a

clear sky model. It is recommended that ``ghi_clearsky`` be calculated
using the Ineichen clear sky model ``pvlib.clearsky.ineichen`` with
``perez_enhancement=True``.

The pvlib implementation limits the clearness index to 1.

Expand Down