DOC: clarify Linke turbidity source and usage in Ineichen clearsky model#2675
Open
kumaradityaapril wants to merge 2 commits intopvlib:mainfrom
Open
DOC: clarify Linke turbidity source and usage in Ineichen clearsky model#2675kumaradityaapril wants to merge 2 commits intopvlib:mainfrom
kumaradityaapril wants to merge 2 commits intopvlib:mainfrom
Conversation
kandersolar
reviewed
Feb 4, 2026
pvlib/clearsky.py
Outdated
| >>> | ||
| >>> tl = lookup_linke_turbidity(times, loc.latitude, loc.longitude) | ||
| >>> cs = ineichen(times, loc.latitude, loc.longitude, | ||
| ... linke_turbidity=tl) |
Member
There was a problem hiding this comment.
Please move this example to the ineichen docstring. It would make more sense there.
pvlib/clearsky.py
Outdated
Comment on lines
33
to
34
| provided by SoDa [4]_, [5]_. Users must supply Linke turbidity values | ||
| explicitly unless providing their own turbidity data. |
Member
There was a problem hiding this comment.
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.
|
|
||
| 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`. |
Member
There was a problem hiding this comment.
Wouldn't it make more sense to include and cite those references in this docstring, instead of referencing the ineichen docstring?
Author
|
Thanks for the helpful review @kandersolar! I've updated the PR to:
Please let me know if this looks good now. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The documentation for
pvlib.clearsky.ineichencould be misleading, as itsuggested that default Linke turbidity values from SoDa are used implicitly.
In reality, these values must be explicitly obtained via
lookup_linke_turbidityand passed toineichen.This PR clarifies the documentation by:
ineichendocstring to explicitly referencelookup_linke_turbidityas the source of SoDa Linke turbidity valueslookup_linke_turbiditydocstring(
lookup_linke_turbidity→ineichen)This is a documentation-only change and does not modify any functionality.