Skip to content

Deprecate modelchain.get_orientation #2495

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 19 commits into from
Jul 31, 2025
Merged

Deprecate modelchain.get_orientation #2495

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4653d9d
enhance tests to check error message
RDaxini Jul 2, 2025
442ee6a
linting, whatsnew
RDaxini Jul 2, 2025
7b7f667
deprecate get_orientation
RDaxini Jul 3, 2025
2a7ac35
remove test
RDaxini Jul 3, 2025
8e25637
Update modelchain.rst
RDaxini Jul 3, 2025
bb3d7df
Update v0.13.1.rst
RDaxini Jul 3, 2025
e2c7fc3
Update v0.13.1.rst
RDaxini Jul 7, 2025
002d782
reinstate test
RDaxini Jul 16, 2025
aef91b7
Merge branch 'main' into modelchain_test
RDaxini Jul 18, 2025
78b71e7
update removal schedule
RDaxini Jul 18, 2025
414f8ca
Merge branch 'modelchain_test' of https://github.com/RDaxini/pvlib-py…
RDaxini Jul 18, 2025
1490b30
reinstate function in docs
RDaxini Jul 18, 2025
77cc6da
revert to default deprecation message
RDaxini Jul 21, 2025
a9f6f93
Merge branch 'main' into modelchain_test
RDaxini Jul 29, 2025
5a64931
remove removal date from whatsnew
RDaxini Jul 30, 2025
dc96311
Merge branch 'main' into modelchain_test
RDaxini Jul 30, 2025
627092a
test deprecationwarning
RDaxini Jul 31, 2025
10081de
linter blank line
RDaxini Jul 31, 2025
c55115e
Update docs/sphinx/source/whatsnew/v0.13.1.rst
kandersolar Jul 31, 2025
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.13.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Breaking Changes

Deprecations
~~~~~~~~~~~~
* Deprecate :py:func:`~pvlib.modelchain.get_orientation`. Removal scheduled for
``v0.14.0``. (:pull:`2691`)
* Rename parameter name ``aparent_azimuth`` to ``solar_azimuth`` in :py:func:`~pvlib.tracking.singleaxis`.
(:issue:`2479`, :pull:`2480`)

Expand Down Expand Up @@ -48,4 +50,4 @@ Contributors
~~~~~~~~~~~~
* Elijah Passmore (:ghuser:`eljpsm`)
* Rajiv Daxini (:ghuser:`RDaxini`)
* Omar Bahamida (:ghuser:`OmarBahamida`)
* Omar Bahamida (:ghuser:`OmarBahamida`)
9 changes: 9 additions & 0 deletions pvlib/modelchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
from pvlib.pvsystem import _DC_MODEL_PARAMS
from pvlib.tools import _build_kwargs

from pvlib._deprecation import deprecated

# keys that are used to detect input data and assign data to appropriate
# ModelChain attribute
# for ModelChain.weather
Expand Down Expand Up @@ -59,6 +61,13 @@
)


@deprecated(
since="0.13.1",
removal="",
name="pvlib.modelchain.get_orientation",
alternative=None,
addendum=None,
)
def get_orientation(strategy, **kwargs):
"""
Determine a PV system's surface tilt and surface azimuth
Expand Down
Loading