DOC: clarify hsu soiling ratio minimum value in docstring#2743
Open
Omesh37 wants to merge 2 commits intopvlib:mainfrom
Open
DOC: clarify hsu soiling ratio minimum value in docstring#2743Omesh37 wants to merge 2 commits intopvlib:mainfrom
Omesh37 wants to merge 2 commits intopvlib:mainfrom
Conversation
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
1 participant
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.
Closes #2534
Summary
Improved the
pvlib.soiling.hsudocstring to clarify that the modelhas an implicit minimum soiling ratio of ~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 → 1.0 at large inputs, SR cannot drop below 1 - 0.3437 = 0.6563.
Changes
Returnsdocstring inpvlib/soiling.py