Skip to content

DOC: add Examples to iam.ashrae docstring #2797

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

Open
dgowdaan-cmyk wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −25
Open

DOC: add Examples to iam.ashrae docstring #2797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1e153e
DOC: add Examples to iam.ashrae docstring
dgowdaan-cmyk Jun 28, 2026
8e1b87b
DOC: add whatsnew entry for iam.ashrae Examples
dgowdaan-cmyk Jun 28, 2026
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
26 changes: 3 additions & 23 deletions docs/sphinx/source/whatsnew/v0.15.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,25 @@
.. _whatsnew_0_15_3:


.. _whatsnew_0_15_3:
v0.15.3 (Anticipated September, 2026)
-------------------------------------

Breaking Changes
~~~~~~~~~~~~~~~~


Deprecations
~~~~~~~~~~~~


Bug fixes
~~~~~~~~~


Enhancements
~~~~~~~~~~~~


Documentation
~~~~~~~~~~~~~


* Added ``Examples`` section to :py:func:`pvlib.iam.ashrae` docstring. :pull:`2797` (:ghuser:`dgowdaan-cmyk`)
Testing
~~~~~~~


Benchmarking
~~~~~~~~~~~~


Requirements
~~~~~~~~~~~~


Maintenance
~~~~~~~~~~~


Contributors
~~~~~~~~~~~~

* :ghuser:`dgowdaan-cmyk`
14 changes: 12 additions & 2 deletions pvlib/iam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ def ashrae(aoi, b=0.05):
pvlib.iam.physical
pvlib.iam.martin_ruiz
pvlib.iam.interp

Examples
--------
>>> import pvlib
>>> pvlib.iam.ashrae(aoi=20)
0.9967911113762044

>>> import numpy as np
>>> pvlib.iam.ashrae(aoi=np.array([0, 30, 50, 90]))
array([1. , 0.99226497, 0.97221381, 0. ])
"""

iam = 1 - b * (1 / np.cos(np.radians(aoi)) - 1)
Expand Down Expand Up @@ -686,7 +696,7 @@ def marion_integrate(function, surface_tilt, region, num=None):
iam : numeric
AOI diffuse correction factor for the specified region.

See Also
See Also
--------
pvlib.iam.marion_diffuse

Expand All @@ -705,7 +715,7 @@ def marion_integrate(function, surface_tilt, region, num=None):
>>> from functools import partial
>>> f = partial(pvlib.iam.physical, n=1.3)
>>> marion_integrate(f, [20, 30], 'sky')
array([0.96225034, 0.9653219 ])
>>> array([0.96225034, 0.9653219 ])
"""

if num is None:
Expand Down