Skip to content

Expand docstring for aoi_projection. #648

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 1 commit into from
Jan 21, 2019
Merged

Expand docstring for aoi_projection. #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,11 @@ def to_doy(x): return x # noqa: E306

def aoi_projection(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth):
"""
Calculates the dot product of the solar vector and the surface
normal.
Calculates the dot product of the sun position unit vector and the surface
normal unit vector; in other words, the cosine of the angle of incidence.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to improve this even slightly more, can you use LaTeX to add the equation?

$$AOI_{projection} = \\cos{ \\beta } \\cos{ \\left( \\text{ solar zenith } \\right) } + \\sin{ \\beta } \\sin{ \\left( \\text{ solar zenith } \\right) } \\cos{ \\left( \\text{ solar azimuth} \\right) - \\left( \\text{ surface azimuth} \\right) }$$

might require some creative thinking about symbols, and some text here or elsewhere to define them. Just an idea

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Next time?


Usage note: When the sun is behind the surface the value returned is
negative. For many uses negative values must be set to zero.

Input all angles in degrees.

Expand Down