diff --git a/docs/sphinx/source/reference/modelchain.rst b/docs/sphinx/source/reference/modelchain.rst index 89de825f0d..56c0cfccd8 100644 --- a/docs/sphinx/source/reference/modelchain.rst +++ b/docs/sphinx/source/reference/modelchain.rst @@ -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 diff --git a/docs/sphinx/source/whatsnew/v0.13.1.rst b/docs/sphinx/source/whatsnew/v0.13.1.rst index cf591f7d0b..981f8fd776 100644 --- a/docs/sphinx/source/whatsnew/v0.13.1.rst +++ b/docs/sphinx/source/whatsnew/v0.13.1.rst @@ -10,6 +10,8 @@ Breaking Changes Deprecations ~~~~~~~~~~~~ +* Deprecate :py:func:`~pvlib.modelchain.get_orientation`. Removal scheduled for + ``v0.14.0``. (:pull:`2691`) Bug fixes @@ -44,3 +46,4 @@ Maintenance Contributors ~~~~~~~~~~~~ * Elijah Passmore (:ghuser:`eljpsm`) +* Rajiv Daxini (:ghuser:`RDaxini`) \ No newline at end of file diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index 52732ebaeb..f448845a0d 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -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 @@ -59,6 +61,13 @@ ) +@deprecated( + since="0.13", + 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