diff --git a/docs/sphinx/source/whatsnew/v0.15.3.rst b/docs/sphinx/source/whatsnew/v0.15.3.rst index 87ded069ee..2a8847ef36 100644 --- a/docs/sphinx/source/whatsnew/v0.15.3.rst +++ b/docs/sphinx/source/whatsnew/v0.15.3.rst @@ -10,6 +10,9 @@ Breaking Changes Deprecations ~~~~~~~~~~~~ +* Deprecate :py:attr:`pvlib.irradiance.king`. + Use other diffuse transposition models in :py:attr:`pvlib.irradiance` instead. + (:issue:`2636`, :pull:`2783`) Bug fixes diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 6c39303b99..04cf6574c2 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -992,6 +992,12 @@ def reindl(surface_tilt, surface_azimuth, dhi, dni, ghi, dni_extra, return sky_diffuse +@deprecated( + since="0.15.3", + removal="0.17.0", + name="pvlib.irradiance.king", + alternative="other diffuse transposition models in pvlib.irradiance", +) def king(surface_tilt, dhi, ghi, solar_zenith): ''' Determine diffuse irradiance from the sky on a tilted surface using diff --git a/tests/test_irradiance.py b/tests/test_irradiance.py index acc8495d3b..cbab3dcd93 100644 --- a/tests/test_irradiance.py +++ b/tests/test_irradiance.py @@ -252,8 +252,9 @@ def test_reindl(irrad_data, ephem_data, dni_et): def test_king(irrad_data, ephem_data): - result = irradiance.king(40, irrad_data['dhi'], irrad_data['ghi'], - ephem_data['apparent_zenith']) + with pytest.warns(pvlibDeprecationWarning, match='king'): + result = irradiance.king(40, irrad_data['dhi'], irrad_data['ghi'], + ephem_data['apparent_zenith']) assert_allclose(result, [0, 44.629352, 115.182626, 79.719855], atol=1e-4)