-
Notifications
You must be signed in to change notification settings - Fork 31
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.
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
Add out_of_bounds parameter to irradiance QC tests #214
base: main
Are you sure you want to change the base?
Conversation
@cwhanse, @kandersolar, @kperrynrel Before completing this I'd appreciate a review of the parameter naming and implementation and whether you can support this for future irradiance QC tests |
The definition of If instead, you want the control the internal workings of the test, and not apply the GHI and zenith bounds, then "skip_bounds=False" makes more sense to me. |
My earlier definition probably wasn't good. The following is probably better:
What I'm trying to achieve is that a test isn't considered failing when the test conditions aren't met (e.g., irradiance is below 50 W/m^2). @cwhanse does this make more sense? |
That makes sense now. "out_of_domain" works for me, "out_of_domain_value" seems like the "value" part is optional. |
@cwhanse @kandersolar This PR is ready for review. Cliff suggested naming the new parameter |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My browser GH is behaving strangely so if the suggested changes look wonky, its not me.
@@ -309,6 +312,9 @@ def check_irradiance_consistency_qcrad(solar_zenith, ghi, dhi, dni, | |||
value is a dict with keys 'zenith_bounds', 'ghi_bounds', and | |||
'ratio_bounds' and value is an ordered pair [lower, upper] | |||
of float. | |||
outside_domain : default False | |||
Value to return when the tests are not applicable, i.e., when the | |||
inputs fall outside the test domain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
inputs fall outside the test domain. | |
irradiance or zenith values fall outside the test domain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think @kandersolar was against listing the specifics. I somewhat agree, as "irradiance values outside the test domain" might be confused as to above/below the threshold. Not a strong feeling though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK. I'm OK with "data" instead of "inputs".
Co-authored-by: Cliff Hansen <[email protected]>
|
||
def check_irradiance_consistency_qcrad(solar_zenith, ghi, dhi, dni, | ||
param=None): | ||
param=None, outside_domain=False): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add "r" to the line below so that the math equations render.
[ ] Added new API functions todocs/api.rst
.in
docs/whatsnew
for all changes. Includes link to the GitHub Issue with
:issue:`num`
or this Pull Request with
:pull:`num`
. Includes contributor nameand/or GitHub username (link with
:ghuser:`user`
).This PR adds an optional
out_of_bounds
parameter to the irradiance QC tests which allows the user to specify whether to Fail (False) or pass (True) a test when the conditions are outside of the valid test domain.