Merge branch 'main' into remove_sapm_spectral_loss

kandersolar · web-flow · commit 1a340e1c1b82 · 2025-03-14T16:26:40.000-04:00
diff --git a/docs/sphinx/source/reference/airmass_atmospheric.rst b/docs/sphinx/source/reference/airmass_atmospheric.rst
@@ -14,7 +14,6 @@ Airmass and atmospheric models
    atmosphere.tdew_from_rh
    atmosphere.rh_from_tdew
    atmosphere.gueymard94_pw
-   atmosphere.first_solar_spectral_correction
    atmosphere.bird_hulstrom80_aod_bb
    atmosphere.kasten96_lt
    atmosphere.angstrom_aod_at_lambda
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst
@@ -8,7 +8,6 @@ Spectrum
 
    spectrum.spectrl2
    spectrum.get_example_spectral_response
-   spectrum.get_am15g
    spectrum.get_reference_spectra
    spectrum.calc_spectral_mismatch_field
    spectrum.spectral_factor_caballero
diff --git a/docs/sphinx/source/whatsnew/v0.10.0.rst b/docs/sphinx/source/whatsnew/v0.10.0.rst
@@ -53,7 +53,7 @@ Deprecations
   deprecated. Use :py:func:`pvlib.pvsystem.v_from_i` and
   :py:func:`pvlib.pvsystem.i_from_v` instead. (:issue:`1626`, :pull:`1743`)
 * Functions for calculating spectral modifiers have been moved to :py:mod:`pvlib.spectrum`:
-  :py:func:`pvlib.atmosphere.first_solar_spectral_correction` is deprecated and
+  :py:func:`!pvlib.atmosphere.first_solar_spectral_correction` is deprecated and
   replaced by :py:func:`~pvlib.spectrum.spectral_factor_firstsolar`, and
   :py:func:`!pvlib.pvsystem.sapm_spectral_loss` is deprecated and replaced by
   :py:func:`~pvlib.spectrum.spectral_factor_sapm`. (:pull:`1628`)
diff --git a/docs/sphinx/source/whatsnew/v0.11.0.rst b/docs/sphinx/source/whatsnew/v0.11.0.rst
@@ -28,7 +28,7 @@ Deprecations
 ~~~~~~~~~~~~
 * The ``pvlib.irradiance.SURFACE_ALBEDOS`` dictionary has been moved to
   :py:const:`pvlib.albedo.SURFACE_ALBEDOS`. (:pull:`2095`)
-* Function :py:func:`pvlib.spectrum.get_am15g` has been deprecated in favor
+* Function :py:func:`!pvlib.spectrum.get_am15g` has been deprecated in favor
   of the new function :py:func:`pvlib.spectrum.get_reference_spectra`. Use
   ``pvlib.spectrum.get_reference_spectra(standard="ASTM G173-03")["global"]``
   instead. (:pull:`2039`)
diff --git a/docs/sphinx/source/whatsnew/v0.11.3.rst b/docs/sphinx/source/whatsnew/v0.11.3.rst
@@ -14,6 +14,12 @@ Breaking Changes
   the spectral model from PVSystem attributes. (:issue:`2017`, :pull:`2253`)
 * Remove deprecated :py:func:`!pvlib.pvsystem.sapm_spectral_loss`.
   (:issue:`2243`, :pull:`2244`)
+* :py:func:`~pvlib.iotools.read_tmy3` now defaults to ``map_variables=True``.
+  Additionally, the deprecated ``recolumn`` parameter is now removed. (:issue:`2324`, :pull:`2408`)
+* Remove :py:func:`!pvlib.atmosphere.first_solar_spectral_correction`, deprecated in v0.10.0.
+  Use :py:func:`~pvlib.spectrum.spectral_factor_firstsolar` instead. (:issue:`2130`, :pull:`2131`)
+* Remove deprecated :py:func:`!pvlib.spectrum.get_am15g` function; use
+  :py:func:`~pvlib.spectrum.get_reference_spectra` instead.  (:pull:`2409`)
 
 Bug fixes
 ~~~~~~~~~
diff --git a/docs/sphinx/source/whatsnew/v0.7.0.rst b/docs/sphinx/source/whatsnew/v0.7.0.rst
@@ -104,7 +104,7 @@ API Changes with Deprecations
 * Changes related to spectral modifier (:issue:`782`):
    * Changes to functions
       - Added the argument `pw_min` and `pw_max`, default values 0.1 and 8 resp.,
-	to `atmosphere.first_solar_spectral_correction`. This function now returns NaN
+	to :py:func:`!pvlib.atmosphere.first_solar_spectral_correction`. This function now returns NaN
 	if pw value higher than `pw_max`.
 * The `times` keyword argument has been deprecated in the
   :py:meth:`pvlib.modelchain.ModelChain.run_model`,
diff --git a/docs/sphinx/source/whatsnew/v0.9.3.rst b/docs/sphinx/source/whatsnew/v0.9.3.rst
@@ -14,7 +14,7 @@ Enhancements
   (:issue:`1516`, :pull:`1518`)
 * New module to calculate spectral mismatch from field spectral measurements
   :py:func:`~pvlib.spectrum.get_example_spectral_response`
-  :py:func:`~pvlib.spectrum.get_am15g`
+  :py:func:`!pvlib.spectrum.get_am15g`
   :py:func:`~pvlib.spectrum.calc_spectral_mismatch_field`
   (:issue:`1523`, :pull:`1524`)
 * Added Townsend-Powers monthly snow loss model:
diff --git a/pvlib/atmosphere.py b/pvlib/atmosphere.py
@@ -6,9 +6,6 @@
 
 import numpy as np
 import pandas as pd
-import pvlib
-
-from pvlib._deprecation import deprecated
 
 APPARENT_ZENITH_MODELS = ('simple', 'kasten1966', 'kastenyoung1989',
                           'gueymard1993', 'pickering2002')
@@ -416,12 +413,6 @@ def tdew_from_rh(temp_air, relative_humidity, coeff=(6.112, 17.62, 243.12)):
     return dewpoint
 
 
-first_solar_spectral_correction = deprecated(
-    since='0.10.0',
-    alternative='pvlib.spectrum.spectral_factor_firstsolar'
-)(pvlib.spectrum.spectral_factor_firstsolar)
-
-
 def bird_hulstrom80_aod_bb(aod380, aod500):
     """
     Approximate broadband aerosol optical depth.
diff --git a/pvlib/iotools/tmy.py b/pvlib/iotools/tmy.py
@@ -3,8 +3,6 @@
 import datetime
 import re
 import pandas as pd
-import warnings
-from pvlib._deprecation import pvlibDeprecationWarning
 
 # Dictionary mapping TMY3 names to pvlib names
 VARIABLE_MAP = {
@@ -24,8 +22,7 @@
 }
 
 
-def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
-              encoding=None):
+def read_tmy3(filename, coerce_year=None, map_variables=True, encoding=None):
     """Read a TMY3 file into a pandas dataframe.
 
     Note that values contained in the metadata dictionary are unchanged
@@ -44,13 +41,9 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
         If supplied, the year of the index will be set to ``coerce_year``, except
         for the last index value which will be set to the *next* year so that
         the index increases monotonically.
-    map_variables : bool, optional
+    map_variables : bool, default True
         When True, renames columns of the DataFrame to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
-    recolumn : bool (deprecated, use map_variables instead)
-        If ``True``, apply standard names to TMY3 columns. Typically this
-        results in stripping the units from the column name.
-        Cannot be used in combination with ``map_variables``.
     encoding : str, optional
         Encoding of the file. For files that contain non-UTF8 characters it may
         be necessary to specify an alternative encoding, e.g., for
@@ -233,74 +226,15 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
     # unit must be in (D,h,m,s,ms,us,ns), but pandas>=0.24 allows unit='hour'
     data.index = data_ymd + pd.to_timedelta(shifted_hour, unit='h') \
         + pd.to_timedelta(minutes, unit='min')
-    # shouldnt' specify both recolumn and map_variables
-    if recolumn is not None and map_variables is not None:
-        msg = "`map_variables` and `recolumn` cannot both be specified"
-        raise ValueError(msg)
-    elif map_variables is None and recolumn is not None:
-        warnings.warn(
-            'The recolumn parameter is deprecated and will be removed in '
-            'pvlib 0.11.0. Use `map_variables` instead, although note that '
-            'its behavior is different from `recolumn`.',
-            pvlibDeprecationWarning)
-    elif map_variables is None and recolumn is None:
-        warnings.warn(
-            'TMY3 variable names will be renamed to pvlib conventions by '
-            'default starting in pvlib 0.11.0. Specify map_variables=True '
-            'to enable that behavior now, or specify map_variables=False '
-            'to hide this warning.', pvlibDeprecationWarning)
+
     if map_variables:
         data = data.rename(columns=VARIABLE_MAP)
-    elif recolumn or (recolumn is None and map_variables is None):
-        data = _recolumn(data)
 
     data = data.tz_localize(int(meta['TZ'] * 3600))
 
     return data, meta
 
 
-def _recolumn(tmy3_dataframe):
-    """
-    Rename the columns of the TMY3 DataFrame.
-
-    Parameters
-    ----------
-    tmy3_dataframe : DataFrame
-    inplace : bool
-        passed to DataFrame.rename()
-
-    Returns
-    -------
-    Recolumned DataFrame.
-    """
-    # paste in the header as one long line
-    raw_columns = 'ETR (W/m^2),ETRN (W/m^2),GHI (W/m^2),GHI source,GHI uncert (%),DNI (W/m^2),DNI source,DNI uncert (%),DHI (W/m^2),DHI source,DHI uncert (%),GH illum (lx),GH illum source,Global illum uncert (%),DN illum (lx),DN illum source,DN illum uncert (%),DH illum (lx),DH illum source,DH illum uncert (%),Zenith lum (cd/m^2),Zenith lum source,Zenith lum uncert (%),TotCld (tenths),TotCld source,TotCld uncert (code),OpqCld (tenths),OpqCld source,OpqCld uncert (code),Dry-bulb (C),Dry-bulb source,Dry-bulb uncert (code),Dew-point (C),Dew-point source,Dew-point uncert (code),RHum (%),RHum source,RHum uncert (code),Pressure (mbar),Pressure source,Pressure uncert (code),Wdir (degrees),Wdir source,Wdir uncert (code),Wspd (m/s),Wspd source,Wspd uncert (code),Hvis (m),Hvis source,Hvis uncert (code),CeilHgt (m),CeilHgt source,CeilHgt uncert (code),Pwat (cm),Pwat source,Pwat uncert (code),AOD (unitless),AOD source,AOD uncert (code),Alb (unitless),Alb source,Alb uncert (code),Lprecip depth (mm),Lprecip quantity (hr),Lprecip source,Lprecip uncert (code),PresWth (METAR code),PresWth source,PresWth uncert (code)'  # noqa: E501
-
-    new_columns = [
-        'ETR', 'ETRN', 'GHI', 'GHISource', 'GHIUncertainty',
-        'DNI', 'DNISource', 'DNIUncertainty', 'DHI', 'DHISource',
-        'DHIUncertainty', 'GHillum', 'GHillumSource', 'GHillumUncertainty',
-        'DNillum', 'DNillumSource', 'DNillumUncertainty', 'DHillum',
-        'DHillumSource', 'DHillumUncertainty', 'Zenithlum',
-        'ZenithlumSource', 'ZenithlumUncertainty', 'TotCld', 'TotCldSource',
-        'TotCldUncertainty', 'OpqCld', 'OpqCldSource', 'OpqCldUncertainty',
-        'DryBulb', 'DryBulbSource', 'DryBulbUncertainty', 'DewPoint',
-        'DewPointSource', 'DewPointUncertainty', 'RHum', 'RHumSource',
-        'RHumUncertainty', 'Pressure', 'PressureSource',
-        'PressureUncertainty', 'Wdir', 'WdirSource', 'WdirUncertainty',
-        'Wspd', 'WspdSource', 'WspdUncertainty', 'Hvis', 'HvisSource',
-        'HvisUncertainty', 'CeilHgt', 'CeilHgtSource', 'CeilHgtUncertainty',
-        'Pwat', 'PwatSource', 'PwatUncertainty', 'AOD', 'AODSource',
-        'AODUncertainty', 'Alb', 'AlbSource', 'AlbUncertainty',
-        'Lprecipdepth', 'Lprecipquantity', 'LprecipSource',
-        'LprecipUncertainty', 'PresWth', 'PresWthSource',
-        'PresWthUncertainty']
-
-    mapping = dict(zip(raw_columns.split(','), new_columns))
-
-    return tmy3_dataframe.rename(columns=mapping)
-
-
 def read_tmy2(filename):
     """
     Read a TMY2 file into a DataFrame.
diff --git a/pvlib/spectrum/__init__.py b/pvlib/spectrum/__init__.py
@@ -8,7 +8,6 @@
     spectral_factor_jrc,
 )
 from pvlib.spectrum.irradiance import (  # noqa: F401
-    get_am15g,
     get_reference_spectra,
     average_photon_energy,
 )
diff --git a/pvlib/spectrum/irradiance.py b/pvlib/spectrum/irradiance.py
@@ -4,7 +4,6 @@
 """
 
 import pvlib
-from pvlib._deprecation import deprecated
 import numpy as np
 import pandas as pd
 from pathlib import Path
@@ -13,68 +12,6 @@
 from scipy.integrate import trapezoid
 
 
-@deprecated(
-    since="0.11",
-    removal="0.12",
-    name="pvlib.spectrum.get_am15g",
-    alternative="pvlib.spectrum.get_reference_spectra",
-    addendum=(
-        "The new function reads more data. Use it with "
-        + "standard='ASTM G173-03' and extract the 'global' column."
-    ),
-)
-def get_am15g(wavelength=None):
-    r"""
-    Read the ASTM G173-03 AM1.5 global spectrum on a 37-degree tilted surface,
-    optionally interpolated to the specified wavelength(s).
-
-    Global (tilted) irradiance includes direct and diffuse irradiance from sky
-    and ground reflections, and is more formally called hemispherical
-    irradiance (on a tilted surface).  In the context of photovoltaic systems
-    the irradiance on a flat receiver is frequently called plane-of-array (POA)
-    irradiance.
-
-    Parameters
-    ----------
-    wavelength: 1-D sequence of numeric, optional
-        Wavelengths at which the spectrum is interpolated.
-        By default the 2002 wavelengths of the standard are returned. [nm].
-
-    Returns
-    -------
-    am15g: pandas.Series
-        The AM1.5g standard spectrum indexed by ``wavelength``. [W/(m²nm)].
-
-    Notes
-    -----
-    If ``wavelength`` is specified this function uses linear interpolation.
-
-    If the values in ``wavelength`` are too widely spaced, the integral of the
-    spectrum may deviate from the standard value of 1000.37 W/m².
-
-    The values in the data file provided with pvlib-python are copied from an
-    Excel file distributed by NREL, which is found here:
-    https://www.nrel.gov/grid/solar-resource/assets/data/astmg173.xls
-
-    More information about reference spectra is found here:
-    https://www.nrel.gov/grid/solar-resource/spectra-am1.5.html
-
-    See Also
-    --------
-    pvlib.spectrum.get_reference_spectra : reads also the direct and
-      extraterrestrial components of the spectrum.
-
-    References
-    ----------
-    .. [1] ASTM "G173-03 Standard Tables for Reference Solar Spectral
-       Irradiances: Direct Normal and Hemispherical on 37° Tilted Surface."
-    """  # noqa: E501
-    # Contributed by Anton Driesse (@adriesse), PV Performance Labs. Aug. 2022
-    # modified by @echedey-ls, as a wrapper of spectrum.get_reference_spectra
-    standard = get_reference_spectra(wavelength, standard="ASTM G173-03")
-    return standard["global"]
-
-
 def get_reference_spectra(wavelengths=None, standard="ASTM G173-03"):
     r"""
     Read a standard spectrum specified by ``standard``, optionally
diff --git a/tests/iotools/test_tmy.py b/tests/iotools/test_tmy.py
@@ -1,10 +1,8 @@
 import numpy as np
 import pandas as pd
 from pvlib.iotools import tmy
-from pvlib._deprecation import pvlibDeprecationWarning
 from tests.conftest import TESTS_DATA_DIR, PVLIB_DATA_DIR
 import pytest
-import warnings
 
 # test the API works
 from pvlib.iotools import read_tmy3
@@ -21,23 +19,11 @@ def test_read_tmy3():
     tmy.read_tmy3(TMY3_TESTFILE, map_variables=False)
 
 
-def test_read_tmy3_recolumn():
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore")
-        data, meta = tmy.read_tmy3(TMY3_TESTFILE, recolumn=True)
-    assert 'GHISource' in data.columns
-
-
 def test_read_tmy3_norecolumn():
     data, _ = tmy.read_tmy3(TMY3_TESTFILE, map_variables=False)
     assert 'GHI source' in data.columns
 
 
-def test_read_tmy3_raise_valueerror():
-    with pytest.raises(ValueError, match='`map_variables` and `recolumn`'):
-        _ = tmy.read_tmy3(TMY3_TESTFILE, recolumn=True, map_variables=True)
-
-
 def test_read_tmy3_map_variables():
     data, meta = tmy.read_tmy3(TMY3_TESTFILE, map_variables=True)
     assert 'ghi' in data.columns
@@ -55,11 +41,6 @@ def test_read_tmy3_map_variables():
     assert 'precipitable_water' in data.columns
 
 
-def test_read_tmy3_map_variables_deprecating_warning():
-    with pytest.warns(pvlibDeprecationWarning, match='names will be renamed'):
-        data, meta = tmy.read_tmy3(TMY3_TESTFILE)
-
-
 def test_read_tmy3_coerce_year():
     coerce_year = 1987
     data, _ = tmy.read_tmy3(TMY3_TESTFILE, coerce_year=coerce_year,
diff --git a/tests/spectrum/test_irradiance.py b/tests/spectrum/test_irradiance.py
@@ -3,27 +3,22 @@
 import pandas as pd
 import numpy as np
 from pvlib import spectrum
-from pvlib._deprecation import pvlibDeprecationWarning
 
 from tests.conftest import assert_series_equal, fail_on_pvlib_version
 
 
 @fail_on_pvlib_version('0.12')
-def test_get_am15g():
+def test_get_reference_spectra_am15g():
     # test that the reference spectrum is read and interpolated correctly
-    with pytest.warns(pvlibDeprecationWarning,
-                      match="get_reference_spectra instead"):
-        e = spectrum.get_am15g()
+    e = spectrum.get_reference_spectra()['global']
     assert_equal(len(e), 2002)
     assert_equal(np.sum(e.index), 2761442)
     assert_approx_equal(np.sum(e), 1002.88, significant=6)
 
     wavelength = [270, 850, 950, 1200, 1201.25, 4001]
     expected = [0.0, 0.893720, 0.147260, 0.448250, 0.4371025, 0.0]
 
-    with pytest.warns(pvlibDeprecationWarning,
-                      match="get_reference_spectra instead"):
-        e = spectrum.get_am15g(wavelength)
+    e = spectrum.get_reference_spectra(wavelength)['global']
     assert_equal(len(e), len(wavelength))
     assert_allclose(e, expected, rtol=1e-6)
 
diff --git a/tests/test_atmosphere.py b/tests/test_atmosphere.py
@@ -9,8 +9,6 @@
 
 from pvlib import atmosphere
 
-from pvlib._deprecation import pvlibDeprecationWarning
-
 
 def test_pres2alt():
     out = atmosphere.pres2alt(np.array([10000, 90000, 101325]))
@@ -235,12 +233,6 @@ def test_tdew_from_rh():
     assert np.isclose(dewpoint_float, dewpoint.iloc[0])
 
 
-def test_first_solar_spectral_correction_deprecated():
-    with pytest.warns(pvlibDeprecationWarning,
-                      match='Use pvlib.spectrum.spectral_factor_firstsolar'):
-        atmosphere.first_solar_spectral_correction(1, 1, 'cdte')
-
-
 def test_kasten96_lt():
     """Test Linke turbidity factor calculated from AOD, Pwat and AM"""
     amp = np.array([1, 3, 5])

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@`
`8`	`8`	`spectral_factor_jrc,`
`9`	`9`	`)`
`10`	`10`	`from pvlib.spectrum.irradiance import ( # noqa: F401`
`11`		`- get_am15g,`
`12`	`11`	`get_reference_spectra,`
`13`	`12`	`average_photon_energy,`
`14`	`13`	`)`