Skip to content

Clarify docstring descriptions of cross-axis slope #1530

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 5 commits into from
Sep 14, 2022
Merged

Clarify docstring descriptions of cross-axis slope #1530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e6b950
Description for tracking.calc_cross_axis_tilt
chiragpachori Aug 16, 2022
79c2865
Merge branch 'master' of https://github.com/pvlib/pvlib-python
cwhanse Sep 14, 2022
17e90e9
up to down
cwhanse Sep 14, 2022
8a5fc59
Update docs/sphinx/source/whatsnew/v0.9.3.rst
cwhanse Sep 14, 2022
ec40e0b
Update docs/sphinx/source/whatsnew/v0.9.3.rst
cwhanse Sep 14, 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
4 changes: 3 additions & 1 deletion docs/sphinx/source/whatsnew/v0.9.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Testing

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


Benchmarking
Expand All @@ -57,4 +58,5 @@ Contributors
* Mark Campanelli (:ghuser:`markcampanelli`)
* Adam R. Jensen (:ghuser:`AdamRJensen`)
* Abhishek Parikh (:ghuser:`abhisheksparikh`)
* Taos Transue (:ghuser:`reepoi`)
* Taos Transue (:ghuser:`reepoi`)
* (:ghuser:`chiragpachori`)
6 changes: 3 additions & 3 deletions pvlib/tracking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class SingleAxisTracker(PVSystem):
using a right-handed convention. For example, trackers with axis
azimuth of 180 degrees (heading south) will have a negative cross-axis
tilt if the tracker axes plane slopes down to the east and positive
cross-axis tilt if the tracker axes plane slopes up to the east. Use
cross-axis tilt if the tracker axes plane slopes down to the west. Use
:func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
`cross_axis_tilt`. [degrees]

Expand Down Expand Up @@ -339,7 +339,7 @@ def singleaxis(apparent_zenith, apparent_azimuth,
using a right-handed convention. For example, trackers with axis
azimuth of 180 degrees (heading south) will have a negative cross-axis
tilt if the tracker axes plane slopes down to the east and positive
cross-axis tilt if the tracker axes plane slopes up to the east. Use
cross-axis tilt if the tracker axes plane slopes down to the west. Use
:func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
`cross_axis_tilt`. [degrees]

Expand Down Expand Up @@ -641,7 +641,7 @@ def calc_cross_axis_tilt(
specified using a right-handed convention. For example, trackers with axis
azimuth of 180 degrees (heading south) will have a negative cross-axis tilt
if the tracker axes plane slopes down to the east and positive cross-axis
tilt if the tracker axes plane slopes up to the east.
tilt if the tracker axes plane slopes down to the west.

Parameters
----------
Expand Down