Deprecations Tracker #2396

This issue is used to track past, present, and future deprecations and make the required follow-ups. Maintainers may update this issue whenever a feature is deprecated, renamed, or removed.

If you have found a deprecated feature that is not here, please report it via a new issue or the mailing list.

- v0.X.Y [[enforcement version]]
  -
  - Removal/Renamed parameter/Renamed function ... `this` [use () after identifier to denote a function]
      - [Recommendation (use alternative)]
      - Deprecated in `v0.x.y`
      - Discussed in #...
      - [List of affected elements:]

Upcoming changes

• Not scheduled (may be as soon as next minor version)

  • Removal of shorthand pvlib.bifacial.pvfactors_timeseries()
    • Use pvlib.bifacial.pvfactors.pvfactors_timeseries instead.
    • Deprecated in v0.9.1
    • ENH: infinite sheds #717
    • [DEP] Remove deprecated shorthand pvlib.bifacial.pvfactors_timeseries #2891
  • Removal of dictionary alias pvlib.irradiance.SURFACE_ALBEDOS
    • Use pvlib.albedo.SURFACE_ALBEDOS instead.
    • Deprecated in v0.11.0
    • Move albedo dictionary from pvlib.irradiance to pvlib.albedo #2095
    • [DEP] Remove pvlib.irradiance.SURFACE_ALBEDOS in favour of pvlib.albedo.SURFACE_ALBEDOS #2890
  • pvlib.tracking.singleaxis()'s parameter apparent_azimuth renamed to solar_azimuth
    • Deprecated in v0.13.1
    • Discussed in Rename solar position inputs in tracking.singleaxis #2480
    • [DEP] Remove deprecated parameter 'apparent_azimuth' from 'pvlib.tracking.singleaxis' #2892

• v0.17.0

  • Removal of attribute pvlib.Location.pytz
    • Use pvlib.Location.tz instead (type has changed internally to Python's native zoneinfo module, in replacement of PyPI's package pytz)
    • Deprecated in v0.15.2
    • Discussed and deprecated in refactor: deprecate pytz in favor of builtin zoneinfo #2757
  • Renaming of pvlib.irradiance.ghi_from_poa_driesse_2023() to pvlib.irradiance.ghi_from_poa_driesse_2024()
    • Use ghi_from_poa_driesse_2024 instead.
    • Deprecated in v0.15.2
    • Wrong year in function name: ghi_from_poa_driesse_2023 #2774, Rename ghi_from_poa_driesse_2023 to ghi_from_poa_driesse_2024 #2777
  • Removal of pvlib.irradiance.king
    • Use other pvlib.irradiance models instead. NB: it affects other functions that list king as available model.
    • Deprecated in v0.16.0
    • irradiance.king documentation and output naming is wrong #2636, Add deprecation warning for irradiance.king #2783

Past changes

• v0.16.0

  • Removal of function pvlib.modelchain.get_orientation()
    • Deprecated in v0.13.1
    • Deprecate modelchain.get_orientation #2495
  • Renamed parameter g_poa_effective
    • Deprecated in v0.13.0
    • Use effective_irradiance instead.
    • Change g_poa_effective to effective_irradiance #2235, Remove g_poa_effective renamed kwarg warning in pvsystem.pvwatts_dc() #2704
  • pvlib.iotools.get_meteonorm_tmy()'s parameter data_version removal
    • Deprecated in v0.15.2
    • It is no longer used in Meteonorm's API.
    • Deprecate and disable data_version parameter in get_meteonorm_tmy #2781
    • iotools parse functions deprecated in v0.13.0
      • parse_cams() Deprecate parse_psm3 and parse_cams #2458
      • parse_psm3() Deprecate parse_psm3 and parse_cams #2458 (already deleted by v0.14.0, Remove psm3.py #2582)
      • parse_bsrn() Deprecate parse_bsrn #2466
      • parse_epw() Deprecate parse_epw #2467
  • pvlib.iotools.get_cams() renamed parameter server to url in v0.13.0
    • Introduced in Change server parameter to url in get_cams #2463
    • Was scheduled to v0.14.0, but was deferred to v0.16.0

• v0.15.0

  • Renamed parameter names dni_clearsky and clearsky_dni in favour of dni_clear
    • Affects pvlib.irradiance.dirindex() and pvlib.irradiance.dni()
    • Deprecated in v0.11.2
    • Standardise variable name for clearsky GHI and DNI, add to glossary #2272
  • Renamed parameter name ghi_clearsky to ghi_clear
    • Affects pvlib.irradiance.dirindex() and pvlib.irradiance.clearsky_index()
    • Deprecated in v0.11.2
    • Standardise variable name for clearsky GHI and DNI, add to glossary #2272

• v0.12.0

  • Removal of parameter recolumn of pvlib.iotools.read_tmy3()
    • Deprecated in v0.10.0
    • [DEPRECATION]: pvlib.iotools.read_tmy3 deprecated recolumn parameter removal scheduled for v0.11.0, still there #2324
  • Removal of function pvsystem.sapm_spectral_loss()
    • Deprecated in v0.10.0
    • Deprecated pvsystem.sapm_spectral_loss not removed #2243
  • Removal of function alias pvlib.atmosphere.first_solar_spectral_correction().
    • Use pvlib.spectrum.spectral_factor_firstsolar() instead.
    • Deprecated in v0.10.0
    • Deprecated pvlib.atmosphere.first_solar_spectral_correction not scheduled for removal #2130
  • Removal of function pvlib.spectrum.get_am15g()
    • Use pvlib.spectrum.get_reference_spectra(standard="ASTM G173-03")["global"] instead
    • Deprecated in v0.11.0

• v0.11.0

  • Removal of function pvlib.modelchain.basic_chain()
    • Remove deprecated basic_chain method #1862
  • Removal of function pvlib.irradiance.poa_horizontal_ratio()
    • pvlib.irradiance.poa_horizontal_ratio should be removed #1697
  • Replacement of function pvlib.iotools.read_srml_month_from_solardat() by pvlib.iotools.get_srml()
    • Deprecated in v0.10.0
    • Add get_srml iotools function; deprecate read_srml_month_from_solardat  #1779
  • Removal of parameter ivcurve_pnts of pvlib.pvsystem.singlediode()