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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+12 −14
Open

Deprecate modelchain.get_orientation #2495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 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
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
9 changes: 0 additions & 9 deletions docs/sphinx/source/reference/modelchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,3 @@ on the information in the associated :py:class:`~pvsystem.PVSystem` object.
modelchain.ModelChain.infer_temperature_model
modelchain.ModelChain.infer_losses_model

Functions
---------

Functions for power modeling.

.. autosummary::
:toctree: generated/

modelchain.get_orientation
3 changes: 3 additions & 0 deletions 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`)
Comment on lines +13 to +14
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
* Deprecate :py:func:`~pvlib.modelchain.get_orientation`. Removal scheduled for
``v0.14.0``. (:pull:`2691`)
* Deprecate :py:func:`~pvlib.modelchain.get_orientation`. (:pull:`2691`)

In case v0.14.0 turns out to be in the next few releases, I think it is better to not mention a version number.

However, I notice that generally I seem to be the only one advocating for not mentioning specific versions regarding deprecation removals. Maybe it's time to discuss and adopt an actual policy here? In the meantime, feel free to overrule me!

Copy link
Member Author

Choose a reason for hiding this comment

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

In case v0.14.0 turns out to be in the next few releases, I think it is better to not mention a version number.

Hmm that's a fair point, I confess I had not thought much about that. I think I am on board with your suggestion. If no-one objects in the next day or two, I'll commit your suggestion.

Maybe it's time to discuss and adopt an actual policy here?

+1

Copy link
Contributor

Choose a reason for hiding this comment

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

I like setting a version more for us, so it does not get forgotten. I understand Kevin's point is to make it more agile.
So I propose that instead of an specific semver, we set it to removal="next version". That's agile, and concrete for users and us.

>>> import pvlib.modelchain as mc
>>> mc.get_orientation('flat')
<stdin>:1: pvlibDeprecationWarning: The pvlib.modelchain.get_orientation function was deprecated in pvlib 0.13 and will be removed in next version.
(0, 180)
>>>

And let's set the patch number too, so it's deprecated in 0.13.x and next version clearly is 0.13.(x+1).



Bug fixes
Expand Down Expand Up @@ -44,3 +46,4 @@ Maintenance
Contributors
~~~~~~~~~~~~
* Elijah Passmore (:ghuser:`eljpsm`)
* Rajiv Daxini (:ghuser:`RDaxini`)
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",
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
since="0.13",
since="0.13.1",

removal="0.14",
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.14",

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
5 changes: 0 additions & 5 deletions tests/test_modelchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1785,11 +1785,6 @@ def test_invalid_models(model, sapm_dc_snl_ac_system, location):
ModelChain(sapm_dc_snl_ac_system, location, **kwargs)


def test_bad_get_orientation():
with pytest.raises(ValueError):
modelchain.get_orientation('bad value')


Comment on lines -1788 to -1792
Copy link
Member

Choose a reason for hiding this comment

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

To add to @echedey-ls's point above, the usual practice would be to wait to remove the tests until we remove the functionality. For the deprecation period, we would usually retain the tests, just slightly modified so that the function calls are inside with pytest.warns(pvlibDeprecationWarning, match="..."): blocks to (1) ensure the deprecation warning is working as expected and (2) prevent that warning from escaping into the test suite's logging output.

I suggest just for the sake of best practice we should do that here too.

# tests for PVSystem with multiple Arrays
def test_with_sapm_pvsystem_arrays(sapm_dc_snl_ac_system_Array, location,
weather):
Expand Down
Loading