Skip to content

Commit ce7ddbc

Browse files
chiragpachoricwhansekandersolar
authored
Clarify docstring descriptions of cross-axis slope (#1530)
* Description for tracking.calc_cross_axis_tilt The previous description for the signs of cross axis tilt mentioned slope azimuth as east for both positive and negative. Corrected it to indicate that sign of cross axis tilt is positive when axis azimuth is south and slope is towards west. * up to down * Update docs/sphinx/source/whatsnew/v0.9.3.rst Co-authored-by: Kevin Anderson <[email protected]> * Update docs/sphinx/source/whatsnew/v0.9.3.rst Co-authored-by: Kevin Anderson <[email protected]> Co-authored-by: Cliff Hansen <[email protected]> Co-authored-by: Kevin Anderson <[email protected]>
1 parent 38fc142 commit ce7ddbc

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/sphinx/source/whatsnew/v0.9.3.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Testing
3535

3636
Documentation
3737
~~~~~~~~~~~~~
38+
* Clarified description of cross-axis slope in :py:mod:`pvlib.tracking` (:pull:`1530`)
3839

3940

4041
Benchmarking
@@ -57,4 +58,5 @@ Contributors
5758
* Mark Campanelli (:ghuser:`markcampanelli`)
5859
* Adam R. Jensen (:ghuser:`AdamRJensen`)
5960
* Abhishek Parikh (:ghuser:`abhisheksparikh`)
60-
* Taos Transue (:ghuser:`reepoi`)
61+
* Taos Transue (:ghuser:`reepoi`)
62+
* (:ghuser:`chiragpachori`)

pvlib/tracking.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class SingleAxisTracker(PVSystem):
5454
using a right-handed convention. For example, trackers with axis
5555
azimuth of 180 degrees (heading south) will have a negative cross-axis
5656
tilt if the tracker axes plane slopes down to the east and positive
57-
cross-axis tilt if the tracker axes plane slopes up to the east. Use
57+
cross-axis tilt if the tracker axes plane slopes down to the west. Use
5858
:func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
5959
`cross_axis_tilt`. [degrees]
6060
@@ -339,7 +339,7 @@ def singleaxis(apparent_zenith, apparent_azimuth,
339339
using a right-handed convention. For example, trackers with axis
340340
azimuth of 180 degrees (heading south) will have a negative cross-axis
341341
tilt if the tracker axes plane slopes down to the east and positive
342-
cross-axis tilt if the tracker axes plane slopes up to the east. Use
342+
cross-axis tilt if the tracker axes plane slopes down to the west. Use
343343
:func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
344344
`cross_axis_tilt`. [degrees]
345345
@@ -641,7 +641,7 @@ def calc_cross_axis_tilt(
641641
specified using a right-handed convention. For example, trackers with axis
642642
azimuth of 180 degrees (heading south) will have a negative cross-axis tilt
643643
if the tracker axes plane slopes down to the east and positive cross-axis
644-
tilt if the tracker axes plane slopes up to the east.
644+
tilt if the tracker axes plane slopes down to the west.
645645
646646
Parameters
647647
----------

0 commit comments

Comments
 (0)