Skip to content

Conversation

echedey-ls
Copy link
Contributor

@echedey-ls echedey-ls commented Sep 7, 2025

  • Closes cross_axis_slope vs cross_axis_tilt #2334
  • I am familiar with the contributing guidelines
  • Tests added
  • [NA] Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • [NA] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

pvlib.shading.shaded_fraction1d uses 'cross_axis_slope' as an input, while pvlib.tracking.singleaxis uses 'cross_axis_tilt'. I think these are the same thing - is that correct? If so, would it make sense to update one of them to be consistent?

Extract from the body message, OP @williamhobbs, #2334 .

Also adds variable description to nomenclature page.

Relevant doc pages

@echedey-ls echedey-ls added api deprecation Use for issues and PRs which involve deprecations labels Sep 7, 2025
@echedey-ls
Copy link
Contributor Author

Currently targets v0.13.1, but I leave this decision up to anybody else (please, assign milestone accordingly). I will update deprecations tracker when merged.

@echedey-ls echedey-ls marked this pull request as ready for review September 7, 2025 20:00
since="0.13.1",
old_param_name="cross_axis_slope",
new_param_name="cross_axis_tilt",
removal="0.15.0",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
removal="0.15.0",

We usually don't specify a removal version as there's not standard timeline for when minor versions come out. If we really wanted to specify a removal, I think this should be in the form of a date, e.g., removal="Earliest September 2026".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I never thought of that, but looks a promising idea

Copy link
Member

@AdamRJensen AdamRJensen Sep 9, 2025

Choose a reason for hiding this comment

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

I'm interested in what @wholmgren thinks of this?

@AdamRJensen
Copy link
Member

The original thread #2334 contained multiple views in favor of cross_axis_slope over cross_axis_tilt. This PR currently implements the latter. Is there a reason for this?

@@ -44,6 +44,20 @@ There is a convention on consistent variable names throughout the library:
bhi
Beam/direct horizontal irradiance

cross_axis_tilt
Cross-axis tilt angle [°].
Copy link
Member

Choose a reason for hiding this comment

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

I guess we should go for this syntax given the current style guide and the rest of the nomenclature page

Suggested change
Cross-axis tilt angle [°].
Cross-axis tilt angle. [°]

Comment on lines +53 to +59
Cross-axis tilt is measured by 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 :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
``cross_axis_tilt``
Copy link
Member

Choose a reason for hiding this comment

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

Just a few style suggestions, mostly my personal preference. Feel free to take them all, cherry pick a few, or reject them all.
Removed "by", swapped "degrees" for °, added a comma after east.

Suggested change
Cross-axis tilt is measured by 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 :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
``cross_axis_tilt``
Cross-axis tilt is measured using a right-handed convention.
For example, trackers with axis azimuth of 180° (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 :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
``cross_axis_tilt``

@echedey-ls
Copy link
Contributor Author

Thanks for the reviews.

@AdamRJensen , yeah, my fault. This is a stale branch I had locally - I guess I took that decision to conform with what already was the term prior to the newer feature and just skimmed through the discussion. I will change this whenever I can to reflect what was discussed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api deprecation Use for issues and PRs which involve deprecations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants