Skip to content

Miscellaneous iam.py docstring updates #2251

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Oct 15, 2024
Merged

Miscellaneous iam.py docstring updates #2251

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c56351e
Update iam.py
RDaxini Oct 9, 2024
de7b99d
restore comment
RDaxini Oct 10, 2024
b1742da
remove blank line
RDaxini Oct 10, 2024
7b3765a
Update iam.py
RDaxini Oct 10, 2024
48c8bb6
sorry for the rapid commit spam
RDaxini Oct 10, 2024
a907f9b
Apply suggestions from code review
RDaxini Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pvlib/iam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ def martin_ruiz(aoi, a_r=0.16):

which is presented as :math:`AL(\alpha) = 1 - IAM` in equation 4 of [1]_,
with :math:`\alpha` representing the angle of incidence AOI. Thus IAM = 1
at AOI = 0, and IAM = 0 at AOI = 90. This equation is only valid for
-90 <= aoi <= 90, therefore `iam` is constrained to 0.0 outside this
at AOI = 0°, and IAM = 0 at AOI = 90°. This equation is only valid for
0° <= aoi <= 90°, therefore `iam` is constrained to 0.0 outside this
interval.

References
Expand Down Expand Up @@ -891,8 +891,8 @@ def schlick_diffuse(surface_tilt):
implements only the integrated Schlick approximation.

Note also that the output of this function (which is an exact integration)
can be compared with the output of :py:func:`marion_diffuse` which numerically
integrates the Schlick approximation:
can be compared with the output of :py:func:`marion_diffuse` which
numerically integrates the Schlick approximation:

.. code::

Expand Down