Set all diffuse IAM outputs to dict - #2842
Open
cbcrespo wants to merge 3 commits into
Open
Conversation
cwhanse
approved these changes
Aug 11, 2026
| iam_sky : numeric | ||
| The incident angle modifier for sky diffuse | ||
| iam : dict | ||
| IAM values for each type of diffuse irradiance (assuming isotropy): |
Member
There was a problem hiding this comment.
Suggested change
| IAM values for each type of diffuse irradiance (assuming isotropy): | |
| IAM values for each type of diffuse irradiance: |
This remark belongs in the docstring's summary section. It's about the model's assumption, rather than describing the values returned by the model. Placing it on the parameter description suggests that there's an option to consider non-isotropic irradiance.
Determine the incidence angle modifiers (IAMs) for sky diffuse and
ground-reflected irradiance using the Martin and Ruiz incident angle model.
As described in [1]_, the IAMs result from integrals that assume the incoming
sky diffuse and ground-reflected irradiance are isotropic.
Comment on lines
588
to
589
| Determine diffuse irradiance incidence angle modifiers using Marion's | ||
| method of integrating over solid angle. |
Member
There was a problem hiding this comment.
Suggested change
| Determine diffuse irradiance incidence angle modifiers (IAMs) using Marion's | |
| method of integrating over solid angle. | |
| The integration assumes the incoming diffuse irradiance is isotropic. |
| ------- | ||
| iam : dict | ||
| IAM values for each type of diffuse irradiance: | ||
| IAM values for each type of diffuse irradiance (assuming isotropy): |
Member
There was a problem hiding this comment.
Suggested change
| IAM values for each type of diffuse irradiance (assuming isotropy): | |
| IAM values for each type of diffuse irradiance: |
| iam_sky : numeric | ||
| The incident angle modifier for sky diffuse. | ||
| iam : dict | ||
| IAM values for each type of diffuse irradiance (assuming isotropy): |
Member
There was a problem hiding this comment.
Suggested change
| IAM values for each type of diffuse irradiance (assuming isotropy): | |
| IAM values for each type of diffuse irradiance: |
| Unlike the Fresnel reflection factor itself, Schlick's approximation can | ||
| be integrated analytically to derive a closed-form equation for diffuse | ||
| IAM factors for the portions of the sky and ground visible | ||
| from a tilted surface if isotropic distributions are assumed. |
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
3 participants
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.This PR sets all diffuse IAM outputs to
dictto avoid inconsistencies between functions. Previously, the output ofmarion_diffusewas adict, butschlick_diffuseandmartin_ruiz_diffusereturned tuples.