DOC: clarify hsu soiling ratio minimum value in docstring#2743
DOC: clarify hsu soiling ratio minimum value in docstring#2743Omesh37 wants to merge 11 commits intopvlib:mainfrom
Conversation
cwhanse
left a comment
There was a problem hiding this comment.
Thanks Omesh37, this is useful additions to the documentation.
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
…com/Omesh37/pvlib-python into doc/hsu-soiling-ratio-minimum-value
|
Thanks for the review @cwhanse
|
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
…com/Omesh37/pvlib-python into doc/hsu-soiling-ratio-minimum-value
|
Thanks for the review @cwhanse |
|
@Omesh37 I copied the pull request template into the first comment. Please answer the two open items. In the future please include the template in pull requests. |
|
And welcome to contributors to pvlib :) |
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
|
Sorry about missing the template @cwhanse! I have now filled out all |
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.Summary
Closes #2534
Improved the
pvlib.soiling.hsudocstring to clarify that the HSU modelhas a minimum soiling ratio of approximately 0.6563, due to the mathematical
limit of the error function in the model equation:
SR = 1 - 0.3437 * erf(0.17 * ω^0.8473)As erf approaches 1.0 at large inputs, SR cannot drop below 1 - 0.3437 = 0.6563.
Detailed explanation has been moved to a Notes section as suggested in review.
Changes
Returnsdocstring inpvlib/soiling.py