Skip to content

docstring updated to indicate limits of axis_tilt #1489

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 9 commits into from
Jul 19, 2022
Merged

docstring updated to indicate limits of axis_tilt #1489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8e7e5c6
docstring updated to indicate limits of axis_tilt
kurt-rhee Jul 6, 2022
f650ecc
updated additional docstrings where the axis_tilt variable is found
kurt-rhee Jul 7, 2022
44fc695
added kurt-rhee to v0.9.2.rst whats new file
kurt-rhee Jul 7, 2022
c6a13c6
changed calc_axis_tilt description of axis tilt
kurt-rhee Jul 7, 2022
bfae2e6
Update pvlib/tracking.py
kurt-rhee Jul 7, 2022
29329ec
Update pvlib/tracking.py
kurt-rhee Jul 7, 2022
2ed3663
Update pvlib/tracking.py
kurt-rhee Jul 7, 2022
194f0f5
Update pvlib/tracking.py
kurt-rhee Jul 7, 2022
6f0d142
Merge branch 'master' into change_pvlib_tracking_docstring
kandersolar Jul 19, 2022
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
1 change: 1 addition & 0 deletions docs/sphinx/source/whatsnew/v0.9.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,4 @@ Contributors
* Kevin Anderson (:ghuser:`kanderso-nrel`)
* Cliff Hansen (:ghuser:`cwhanse`)
* Jules Chéron (:ghuser:`jules-ch`)
* Kurt Rhee (:ghuser:`kurt-rhee`)
16 changes: 11 additions & 5 deletions pvlib/tracking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ class SingleAxisTracker(PVSystem):
----------
axis_tilt : float, default 0
The tilt of the axis of rotation (i.e, the y-axis defined by
axis_azimuth) with respect to horizontal, in decimal degrees.
``axis_azimuth``) with respect to horizontal.
``axis_tilt`` must be >= 0 and <= 90. [degree]

axis_azimuth : float, default 0
A value denoting the compass direction along which the axis of
Expand Down Expand Up @@ -294,7 +295,8 @@ def singleaxis(apparent_zenith, apparent_azimuth,

axis_tilt : float, default 0
The tilt of the axis of rotation (i.e, the y-axis defined by
axis_azimuth) with respect to horizontal, in decimal degrees.
``axis_azimuth``) with respect to horizontal.
``axis_tilt`` must be >= 0 and <= 90. [degree]

axis_azimuth : float, default 0
A value denoting the compass direction along which the axis of
Expand Down Expand Up @@ -480,7 +482,8 @@ def calc_surface_orientation(tracker_theta, axis_tilt=0, axis_azimuth=0):
results in ``surface_azimuth`` to the West while ``tracker_theta < 0``
results in ``surface_azimuth`` to the East. [degree]
axis_tilt : float, default 0
The tilt of the axis of rotation with respect to horizontal. [degree]
The tilt of the axis of rotation with respect to horizontal.
``axis_tilt`` must be >= 0 and <= 90. [degree]
axis_azimuth : float, default 0
A value denoting the compass direction along which the axis of
rotation lies. Measured east of north. [degree]
Expand Down Expand Up @@ -524,7 +527,9 @@ def calc_surface_orientation(tracker_theta, axis_tilt=0, axis_azimuth=0):
def calc_axis_tilt(slope_azimuth, slope_tilt, axis_azimuth):
"""
Calculate tracker axis tilt in the global reference frame when on a sloped
plane.
plane. Axis tilt is the inclination of the tracker rotation axis with
respect to horizontal, ranging from 0 degrees (horizontal axis) to 90
degrees (vertical axis).

Parameters
----------
Expand Down Expand Up @@ -639,7 +644,8 @@ def calc_cross_axis_tilt(
axis_azimuth : float
direction of tracker axes projected on the horizontal [degrees]
axis_tilt : float
tilt of trackers relative to horizontal [degrees]
tilt of trackers relative to horizontal. ``axis_tilt`` must be >= 0
and <= 90. [degree]

Returns
-------
Expand Down