Skip to content

Note deprecation of king in get_total_irradiance and get_sky_diffuse docstrings #2904

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
kandersolar merged 3 commits into from
Oct 25, 2026
+8 −4
Merged

Note deprecation of king in get_total_irradiance and get_sky_diffuse docstrings #2904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71a3123
Note deprecation of king in get_total_irradiance and get_sky_diffuse …
Blizzeq Oct 17, 2026
8097266
Remove out-of-scope deprecation tests, link PR in whatsnew
Blizzeq Oct 22, 2026
50f39f1
Merge remote-tracking branch 'upstream/main' into docs/deprecate-king…
Blizzeq Oct 22, 2026
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: 4 additions & 0 deletions docs/sphinx/source/whatsnew/v0.16.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -69,3 +72,4 @@ Contributors
* jason-writer (:ghuser:`jason-writer`)
* :ghuser:`bfs2021`
* :ghuser:`xiajiahang`
* Jakub Krasuski (:ghuser:`Blizzeq`)
8 changes: 4 additions & 4 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def get_total_irradiance(surface_tilt, surface_azimuth,
* klucher
* haydavies
* reindl
* king
* king (deprecated)
* perez
* perez-driesse
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -387,7 +387,7 @@ def get_sky_diffuse(surface_tilt, surface_azimuth,
* klucher
* haydavies
* reindl
* king
* king (deprecated)
* perez
* perez-driesse
Expand Down Expand Up @@ -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`.
Expand Down