diff --git a/docs/sphinx/source/whatsnew/v0.16.2.rst b/docs/sphinx/source/whatsnew/v0.16.2.rst index 64132a2547..834ef7ee37 100644 --- a/docs/sphinx/source/whatsnew/v0.16.2.rst +++ b/docs/sphinx/source/whatsnew/v0.16.2.rst @@ -40,6 +40,9 @@ Documentation * Clarify that :py:func:`pvlib.ivtools.sdm.fit_pvsyst_sandia` and :py:func:`pvlib.ivtools.sdm.fit_desoto_sandia` require multiple IV curves. (:issue:`1715`, :pull:`2883`) +* Note deprecation of ``king`` model in :py:func:`~pvlib.irradiance.get_total_irradiance` + and :py:func:`~pvlib.irradiance.get_sky_diffuse` docstrings. + (:issue:`2897`, :pull:`2904`) Testing @@ -69,3 +72,4 @@ Contributors * jason-writer (:ghuser:`jason-writer`) * :ghuser:`bfs2021` * :ghuser:`xiajiahang` +* Jakub Krasuski (:ghuser:`Blizzeq`) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 38bf122b91..9c65453473 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -295,7 +295,7 @@ def get_total_irradiance(surface_tilt, surface_azimuth, * klucher * haydavies * reindl - * king + * king (deprecated) * perez * perez-driesse @@ -328,7 +328,7 @@ def get_total_irradiance(surface_tilt, surface_azimuth, the list of accepted values. model : str, default 'isotropic' Irradiance model. Can be one of ``'isotropic'``, ``'klucher'``, - ``'haydavies'``, ``'reindl'``, ``'king'``, ``'perez'``, + ``'haydavies'``, ``'reindl'``, ``'king'`` (deprecated), ``'perez'``, ``'perez-driesse'``. model_perez : str, default 'allsitescomposite1990' Used only if ``model='perez'``. See :py:func:`~pvlib.irradiance.perez`. @@ -387,7 +387,7 @@ def get_sky_diffuse(surface_tilt, surface_azimuth, * klucher * haydavies * reindl - * king + * king (deprecated) * perez * perez-driesse @@ -415,7 +415,7 @@ def get_sky_diffuse(surface_tilt, surface_azimuth, See :term:`airmass_relative`. [unitless] model : str, default 'isotropic' Irradiance model. Can be one of ``'isotropic'``, ``'klucher'``, - ``'haydavies'``, ``'reindl'``, ``'king'``, ``'perez'``, + ``'haydavies'``, ``'reindl'``, ``'king'`` (deprecated), ``'perez'``, ``'perez-driesse'``. model_perez : str, default 'allsitescomposite1990' Used only if ``model='perez'``. See :py:func:`~pvlib.irradiance.perez`.