Skip to content

DOC: clarify Linke turbidity source and usage in Ineichen clearsky model #2675

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

Closed
kumaradityaapril wants to merge 2 commits into from
+24 −1
Closed

DOC: clarify Linke turbidity source and usage in Ineichen clearsky model #2675

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab96973
DOC: clarify Linke turbidity source and usage for Ineichen clearsky m…
kumaradityaapril Feb 3, 2026
b395ef2
DOC: move Ineichen example and clarify Linke turbidity references
kumaradityaapril Feb 4, 2026
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
23 changes: 22 additions & 1 deletion pvlib/clearsky.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
report on clear sky models found the Ineichen/Perez model to have
excellent performance with a minimal input data set [3]_.

Default values for monthly Linke turbidity provided by SoDa [4]_, [5]_.
Default monthly Linke turbidity values are available via
:py:func:`pvlib.clearsky.lookup_linke_turbidity`, which uses data
provided by SoDa [4]_, [5]_. Users must supply Linke turbidity values
explicitly unless providing their own turbidity data.
Copy link
Member

@kandersolar kandersolar Feb 4, 2026

Choose a reason for hiding this comment

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

Suggested change
provided by SoDa [4]_, [5]_. Users must supply Linke turbidity values
explicitly unless providing their own turbidity data.
provided by SoDa [4]_, [5]_.

This sentence doesn't make sense to me. I suggest deleting it.


Parameters
-----------
Expand Down Expand Up @@ -150,6 +153,10 @@ def lookup_linke_turbidity(time, latitude, longitude, filepath=None,
Look up the Linke Turibidity from the ``LinkeTurbidities.h5``
data file supplied with pvlib.

The Linke turbidity climatology used by this function is sourced from
SoDa (Solar Radiation Data) and corresponds to the references cited in
:py:func:`pvlib.clearsky.ineichen`.
Copy link
Member

@kandersolar kandersolar Feb 4, 2026

Choose a reason for hiding this comment

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

Wouldn't it make more sense to include and cite those references in this docstring, instead of referencing the ineichen docstring?


Parameters
----------
time : pandas.DatetimeIndex
Expand All @@ -175,6 +182,20 @@ def lookup_linke_turbidity(time, latitude, longitude, filepath=None,
The returned value for each time is either the monthly value or an
interpolated value to smooth the transition between months.
Interpolation is done on the day of year as determined by UTC.

Examples
--------
>>> from pvlib.clearsky import lookup_linke_turbidity, ineichen
>>> from pvlib.location import Location
>>> import pandas as pd
>>>
>>> times = pd.date_range('2024-06-01', freq='1H', periods=24, tz='UTC')
>>> loc = Location(35, -110)
>>>
>>> tl = lookup_linke_turbidity(times, loc.latitude, loc.longitude)
>>> cs = ineichen(times, loc.latitude, loc.longitude,
... linke_turbidity=tl)
Copy link
Member

@kandersolar kandersolar Feb 4, 2026

Choose a reason for hiding this comment

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

Please move this example to the ineichen docstring. It would make more sense there.


"""

# The .h5 file 'LinkeTurbidities.h5' contains a single 2160 x 4320 x 12
Expand Down