Skip to content

Correct cloud_cover_to_transmittance_linear documentation #1370

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 7 commits into from
Jan 15, 2022
Merged

Correct cloud_cover_to_transmittance_linear documentation #1370

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5a70881
Modify cloud_cover_to_transmittance_linear documentation replacing gh…
Jan 7, 2022
a8602ed
Add documentation lines into v0.9.1.rst
Jan 7, 2022
6b6e1a2
Modify line length in documentation
Jan 7, 2022
4034f5a
Small modifs doc forecast.py
Jan 7, 2022
d6e0feb
Small modifs doc forecast.py
Jan 7, 2022
6d4f967
Update pvlib/forecast.py
JoLo90 Jan 7, 2022
3beecc4
Rewording documentation forecast.py
Jan 7, 2022
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
4 changes: 4 additions & 0 deletions docs/sphinx/source/whatsnew/v0.9.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Testing

Documentation
~~~~~~~~~~~~~
* Fix documentation return error in :py:meth:`pvlib.forecast.ForecastModel.cloud_cover_to_transmittance_linear`
(:issue:`1367`, :pull:`1370`)


Requirements
~~~~~~~~~~~~
Expand All @@ -41,3 +44,4 @@ Contributors
* Christian Weickhmann (:ghuser:`cweickhmann`)
* Kevin Anderson (:ghuser:`kanderso-nrel`)
* Adam R. Jensen (:ghuser:`AdamRJensen`)
* Johann Loux (:ghuser:`JoLo90`)
10 changes: 5 additions & 5 deletions pvlib/forecast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,8 +512,8 @@ def cloud_cover_to_irradiance_clearsky_scaling(self, cloud_cover,
def cloud_cover_to_transmittance_linear(self, cloud_cover, offset=0.75,
**kwargs):
"""
Convert cloud cover to atmospheric transmittance using a linear
model.
Convert cloud cover (percentage) to atmospheric transmittance (ratio)
using a linear model.

0% cloud cover returns offset.

Expand All @@ -524,14 +524,14 @@ def cloud_cover_to_transmittance_linear(self, cloud_cover, offset=0.75,
cloud_cover : numeric
Cloud cover in %.
offset : numeric, default 0.75
Determines the maximum transmittance.
Determines the maximum transmittance (ratio).
kwargs
Not used.

Returns
-------
ghi : numeric
Estimated GHI.
transmittance : numeric
Estimated transmittance (ratio).
"""
transmittance = ((100.0 - cloud_cover) / 100.0) * offset

Expand Down