Raise helpful exceptions for irradiance.gti_dirint #2347
Conversation
This file contains 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
kandersolar
reviewed
Jan 29, 2025
adriesse
reviewed
Jan 30, 2025
adriesse
reviewed
Jan 30, 2025
| @@ -2368,6 +2368,9 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times, | |||
| irradiance, Solar Energy 122, 1037-1046. | |||
| :doi:`10.1016/j.solener.2015.10.024` | |||
| """ | |||
| # check input data and raise Exceptions where data will cause the | |||
| # algorithm to fail | |||
| _gti_dirint_check_input(aoi) | |||
There was a problem hiding this comment.
I wouldn't bother with a function for this.
There was a problem hiding this comment.
I wouldn't either if this was the only condition to check. But I'm certain there are other data requirements which we haven't deduced yet and thought it helpful to put the function in place to collect checks.
There was a problem hiding this comment.
There's probably some pythonic aphorism for these situations.
Co-authored-by: Anton Driesse <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[] Updates entries indocs/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.gti_dirintcould fail for a number of not-well-defined conditions. One known condition is reported in #1342, where all inputs have AOI >= 90.I could not determine exactly how much data is "required" by
gti_dirint. For instance, if there are insufficient daily data with 60 < AOI < 85 (see these lines), the function will proceed withkt_prime_gte_90= np.nanand will basically assume that the day is entirely clear at this line. I can't say that's a failure of the code, but I'm skeptical thatgti_dirintwill return anything meaningful. I don't know if we want to check, or what exception or warning to raise.In any case, the check added in this PR closes the issue reported in #1342, and sets up
gti_dirintto have additional checks added, should that be desired.