Skip to content

Commit 52eeae7

Browse files
adriessecwhanse
authored andcommitted
Expand docstring for aoi_projection. (#648)
1 parent d6d1492 commit 52eeae7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

pvlib/irradiance.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,11 @@ def to_doy(x): return x # noqa: E306
154154

155155
def aoi_projection(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth):
156156
"""
157-
Calculates the dot product of the solar vector and the surface
158-
normal.
157+
Calculates the dot product of the sun position unit vector and the surface
158+
normal unit vector; in other words, the cosine of the angle of incidence.
159+
160+
Usage note: When the sun is behind the surface the value returned is
161+
negative. For many uses negative values must be set to zero.
159162
160163
Input all angles in degrees.
161164

0 commit comments

Comments
 (0)