DOC: clarify Linke turbidity source and usage in Ineichen clearsky model#2675
DOC: clarify Linke turbidity source and usage in Ineichen clearsky model#2675kumaradityaapril wants to merge 2 commits intopvlib:mainfrom
Conversation
pvlib/clearsky.py
Outdated
| >>> | ||
| >>> tl = lookup_linke_turbidity(times, loc.latitude, loc.longitude) | ||
| >>> cs = ineichen(times, loc.latitude, loc.longitude, | ||
| ... linke_turbidity=tl) |
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
| provided by SoDa [4]_, [5]_. Users must supply Linke turbidity values | ||
| explicitly unless providing their own turbidity data. |
There was a problem hiding this comment.
| 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`. |
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?
|
Thanks for the helpful review @kandersolar! I've updated the PR to:
Please let me know if this looks good now. |
|
This PR has significant issues (the example code does not work, earlier review points were claimed to be addressed but in fact were not). @kumaradityaapril pvlib is developed by solar energy modelers and is a difficult project for general programmers to get involved with. Unfortunately, our reviewer capacity is limited and we cannot accept PRs from people without solar experience. Therefore I am closing this PR. |
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.