change new names to sapm and first_solar

in coordination with pvlib#1658, drop "spectral_correction" from the new function names

Author: kandersolar

docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst

@@ -10,5 +10,5 @@ Spectrum
    spectrum.get_example_spectral_response
    spectrum.get_am15g
    spectrum.calc_spectral_mismatch_field
-   spectrum.first_solar_spectral_correction
-   spectrum.sapm_spectral_correction
+   spectrum.first_solar
+   spectrum.sapm

docs/sphinx/source/whatsnew/v0.9.5.rst

@@ -14,9 +14,9 @@ Deprecations
 ~~~~~~~~~~~~
 * Functions for calculating spectral modifiers have been moved to :py:mod:`pvlib.spectrum`:
   ``pvlib.atmosphere.first_solar_spectral_correction`` is now
-  :py:func:`pvlib.spectrum.first_solar_spectral_correction` and
+  :py:func:`pvlib.spectrum.first_solar` and
   ``pvlib.pvsystem.sapm_spectral_loss`` is now
-  :py:func:`pvlib.spectrum.sapm_spectral_correction`. (:pull:`1628`)
+  :py:func:`pvlib.spectrum.sapm`. (:pull:`1628`)
 
 
 Enhancements

pvlib/atmosphere.py

@@ -323,8 +323,8 @@ def gueymard94_pw(temp_air, relative_humidity):
 
 first_solar_spectral_correction = deprecated(
     since='0.9.5',
-    alternative='pvlib.spectrum.first_solar_spectral_correction'
-)(pvlib.spectrum.first_solar_spectral_correction)
+    alternative='pvlib.spectrum.first_solar'
+)(pvlib.spectrum.first_solar)
 
 
 def bird_hulstrom80_aod_bb(aod380, aod500):

pvlib/pvsystem.py

@@ -672,7 +672,7 @@ def sapm_celltemp(self, poa_global, temp_air, wind_speed):
     @_unwrap_single_value
     def sapm_spectral_loss(self, airmass_absolute):
         """
-        Use the :py:func:`pvlib.spectrum.sapm_spectral_correction` function,
+        Use the :py:func:`pvlib.spectrum.sapm` function,
         the input parameters, and ``self.module_parameters`` to calculate F1.
 
         Parameters
@@ -686,8 +686,7 @@ def sapm_spectral_loss(self, airmass_absolute):
             The SAPM spectral loss coefficient.
         """
         return tuple(
-            spectrum.sapm_spectral_correction(airmass_absolute,
-                                              array.module_parameters)
+            spectrum.sapm(airmass_absolute, array.module_parameters)
             for array in self.arrays
         )
 
@@ -885,7 +884,7 @@ def noct_sam_celltemp(self, poa_global, temp_air, wind_speed,
     @_unwrap_single_value
     def first_solar_spectral_loss(self, pw, airmass_absolute):
         """
-        Use :py:func:`pvlib.spectrum.first_solar_spectral_correction` to
+        Use :py:func:`pvlib.spectrum.first_solar` to
         calculate the spectral loss modifier. The model coefficients are
         specific to the module's cell type, and are determined by searching
         for one of the following keys in self.module_parameters (in order):
@@ -926,9 +925,8 @@ def _spectral_correction(array, pw):
                 module_type = array._infer_cell_type()
                 coefficients = None
 
-            return spectrum.first_solar_spectral_correction(
-                pw, airmass_absolute,
-                module_type, coefficients
+            return spectrum.first_solar(
+                pw, airmass_absolute, module_type, coefficients
             )
         return tuple(
             itertools.starmap(_spectral_correction, zip(self.arrays, pw))
@@ -2601,8 +2599,8 @@ def sapm(effective_irradiance, temp_cell, module):
 
 sapm_spectral_loss = deprecated(
     since='0.9.5',
-    alternative='pvlib.spectrum.sapm_spectral_correction'
-)(spectrum.sapm_spectral_correction)
+    alternative='pvlib.spectrum.sapm'
+)(spectrum.sapm)
 
 
 def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
@@ -2662,11 +2660,11 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
     See also
     --------
     pvlib.iam.sapm
-    pvlib.spectrum.sapm_spectral_correction
+    pvlib.spectrum.sapm
     pvlib.pvsystem.sapm
     """
 
-    F1 = spectrum.sapm_spectral_correction(airmass_absolute, module)
+    F1 = spectrum.sapm(airmass_absolute, module)
     F2 = iam.sapm(aoi, module)
 
     Ee = F1 * (poa_direct * F2 + module['FD'] * poa_diffuse)

pvlib/spectrum/__init__.py

@@ -1,8 +1,8 @@
 from pvlib.spectrum.spectrl2 import spectrl2  # noqa: F401
 from pvlib.spectrum.mismatch import (  # noqa: F401
     calc_spectral_mismatch_field,
-    first_solar_spectral_correction,
+    first_solar,
     get_am15g,
     get_example_spectral_response,
-    sapm_spectral_correction,
+    sapm,
 )

pvlib/spectrum/mismatch.py

@@ -239,9 +239,8 @@ def integrate(e):
     return smm
 
 
-def first_solar_spectral_correction(pw, airmass_absolute,
-                                    module_type=None, coefficients=None,
-                                    min_pw=0.1, max_pw=8):
+def first_solar(pw, airmass_absolute, module_type=None, coefficients=None,
+                min_pw=0.1, max_pw=8):
     r"""
     Spectral mismatch modifier based on precipitable water and absolute
     (pressure-adjusted) airmass.
@@ -410,7 +409,7 @@ def first_solar_spectral_correction(pw, airmass_absolute,
     return modifier
 
 
-def sapm_spectral_correction(airmass_absolute, module):
+def sapm(airmass_absolute, module):
     """
     Calculates the SAPM spectral loss coefficient, F1.
 

pvlib/tests/test_atmosphere.py

@@ -89,7 +89,7 @@ def test_gueymard94_pw():
 
 def test_first_solar_spectral_correction_deprecated():
     with pytest.warns(pvlibDeprecationWarning,
-                      match='Use pvlib.spectrum.first_solar_spectral'):
+                      match='Use pvlib.spectrum.first_solar'):
         atmosphere.first_solar_spectral_correction(1, 1, 'cdte')
 
 

pvlib/tests/test_spectrum.py

@@ -195,65 +195,64 @@ def test_calc_spectral_mismatch_field(spectrl2_data):
          [ 1.11225204, 0.93665901, 0.78487953],
          [ 1.14555295, 0.97084011, 0.81994083]]))
 ])
-def test_first_solar_spectral_correction(module_type, expect):
+def test_first_solar(module_type, expect):
     ams = np.array([1, 3, 5])
     pws = np.array([1, 3, 5])
     ams, pws = np.meshgrid(ams, pws)
-    out = spectrum.first_solar_spectral_correction(pws, ams, module_type)
+    out = spectrum.first_solar(pws, ams, module_type)
     assert_allclose(out, expect, atol=0.001)
 
 
-def test_first_solar_spectral_correction_supplied():
+def test_first_solar_supplied():
     # use the cdte coeffs
     coeffs = (0.87102, -0.040543, -0.00929202, 0.10052, 0.073062, -0.0034187)
-    out = spectrum.first_solar_spectral_correction(1, 1, coefficients=coeffs)
+    out = spectrum.first_solar(1, 1, coefficients=coeffs)
     expected = 0.99134828
     assert_allclose(out, expected, atol=1e-3)
 
 
-def test_first_solar_spectral_correction_ambiguous():
+def test_first_solar_ambiguous():
     with pytest.raises(TypeError):
-        spectrum.first_solar_spectral_correction(1, 1)
+        spectrum.first_solar(1, 1)
 
 
-def test_first_solar_spectral_correction_ambiguous_both():
+def test_first_solar_ambiguous_both():
     # use the cdte coeffs
     coeffs = (0.87102, -0.040543, -0.00929202, 0.10052, 0.073062, -0.0034187)
     with pytest.raises(TypeError):
-        spectrum.first_solar_spectral_correction(1, 1, 'cdte',
-                                                 coefficients=coeffs)
+        spectrum.first_solar(1, 1, 'cdte', coefficients=coeffs)
 
 
-def test_first_solar_spectral_correction_large_airmass():
+def test_first_solar_large_airmass():
     # test that airmass > 10 is treated same as airmass==10
-    m_eq10 = spectrum.first_solar_spectral_correction(1, 10, 'monosi')
-    m_gt10 = spectrum.first_solar_spectral_correction(1, 15, 'monosi')
+    m_eq10 = spectrum.first_solar(1, 10, 'monosi')
+    m_gt10 = spectrum.first_solar(1, 15, 'monosi')
     assert_allclose(m_eq10, m_gt10)
 
 
-def test_first_solar_spectral_correction_low_airmass():
+def test_first_solar_low_airmass():
     with pytest.warns(UserWarning, match='Exceptionally low air mass'):
-        _ = spectrum.first_solar_spectral_correction(1, 0.1, 'monosi')
+        _ = spectrum.first_solar(1, 0.1, 'monosi')
 
 
-def test_first_solar_spectral_correction_range():
+def test_first_solar_range():
     with pytest.warns(UserWarning, match='Exceptionally high pw values'):
-        out = spectrum.first_solar_spectral_correction(np.array([.1, 3, 10]),
+        out = spectrum.first_solar(np.array([.1, 3, 10]),
                                                        np.array([1, 3, 5]),
                                                        module_type='monosi')
     expected = np.array([0.96080878, 1.03055092, np.nan])
     assert_allclose(out, expected, atol=1e-3)
     with pytest.warns(UserWarning, match='Exceptionally high pw values'):
-        out = spectrum.first_solar_spectral_correction(6, 1.5, max_pw=5,
+        out = spectrum.first_solar(6, 1.5, max_pw=5,
                                                        module_type='monosi')
     with pytest.warns(UserWarning, match='Exceptionally low pw values'):
-        out = spectrum.first_solar_spectral_correction(np.array([0, 3, 8]),
+        out = spectrum.first_solar(np.array([0, 3, 8]),
                                                        np.array([1, 3, 5]),
                                                        module_type='monosi')
     expected = np.array([0.96080878, 1.03055092, 1.04932727])
     assert_allclose(out, expected, atol=1e-3)
     with pytest.warns(UserWarning, match='Exceptionally low pw values'):
-        out = spectrum.first_solar_spectral_correction(0.2, 1.5, min_pw=1,
+        out = spectrum.first_solar(0.2, 1.5, min_pw=1,
                                                        module_type='monosi')
 
 
@@ -262,9 +261,9 @@ def test_first_solar_spectral_correction_range():
     (np.array([[10, np.nan]]), np.array([[0.999535, 0]])),
     (pd.Series([5]), pd.Series([1.0387675]))
 ])
-def test_sapm_spectral_loss(sapm_module_params, airmass, expected):
+def test_sapm(sapm_module_params, airmass, expected):
 
-    out = spectrum.sapm_spectral_correction(airmass, sapm_module_params)
+    out = spectrum.sapm(airmass, sapm_module_params)
 
     if isinstance(airmass, pd.Series):
         assert_series_equal(out, expected, check_less_precise=4)