add _2025 to function name

Author: kandersolar

docs/sphinx/source/reference/pv_modeling/parameters.rst

@@ -12,7 +12,7 @@ Functions for fitting single diode models
     ivtools.sdm.fit_cec_sam
     ivtools.sdm.fit_desoto
     ivtools.sdm.fit_pvsyst_sandia
-    ivtools.sdm.fit_pvsyst_iec61853_sandia
+    ivtools.sdm.fit_pvsyst_iec61853_sandia_2025
     ivtools.sdm.fit_desoto_sandia
 
 Functions for fitting the single diode equation

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

@@ -16,7 +16,7 @@ Enhancements
 ~~~~~~~~~~~~
 * :py:mod:`pvlib.ivtools.sdm` is now a subpackage. (:issue:`2252`, :pull:`2256`)
 * Add a function for estimating PVsyst SDM parameters from IEC 61853-1 matrix
-  data (:py:func:`~pvlib.ivtools.sdm.fit_pvsyst_iec61853_sandia`). (:issue:`2185`, :pull:`2429`)
+  data (:py:func:`~pvlib.ivtools.sdm.fit_pvsyst_iec61853_sandia_2025`). (:issue:`2185`, :pull:`2429`)
 
 Documentation
 ~~~~~~~~~~~~~

pvlib/ivtools/sdm/__init__.py

@@ -15,6 +15,6 @@
 
 from pvlib.ivtools.sdm.pvsyst import (  # noqa: F401
     fit_pvsyst_sandia,
-    fit_pvsyst_iec61853_sandia,
+    fit_pvsyst_iec61853_sandia_2025,
     pvsyst_temperature_coeff,
 )

pvlib/ivtools/sdm/pvsyst.py

@@ -310,14 +310,14 @@ def maxp(temp_cell, irrad_ref, alpha_sc, gamma_ref, mu_gamma, I_L_ref,
     return gamma_pdc / pmp
 
 
-def fit_pvsyst_iec61853_sandia(effective_irradiance, temp_cell,
-                               i_sc, v_oc, i_mp, v_mp,
-                               cells_in_series, EgRef=1.121,
-                               alpha_sc=None, beta_mp=None,
-                               R_s=None, r_sh_coeff=0.12,
-                               min_Rsh_irradiance=None,
-                               irradiance_tolerance=20,
-                               temperature_tolerance=1):
+def fit_pvsyst_iec61853_sandia_2025(effective_irradiance, temp_cell,
+                                    i_sc, v_oc, i_mp, v_mp,
+                                    cells_in_series, EgRef=1.121,
+                                    alpha_sc=None, beta_mp=None,
+                                    R_s=None, r_sh_coeff=0.12,
+                                    min_Rsh_irradiance=None,
+                                    irradiance_tolerance=20,
+                                    temperature_tolerance=1):
     """
     Estimate parameters for the PVsyst module performance model using
     IEC 61853-1 matrix measurements.
@@ -420,42 +420,45 @@ def fit_pvsyst_iec61853_sandia(effective_irradiance, temp_cell,
                           atol=temperature_tolerance)
 
     if alpha_sc is None:
-        mu_i_sc = _fit_tempco_pvsyst_iec61853_sandia(i_sc[is_g_stc],
-                                                     temp_cell[is_g_stc])
+        mu_i_sc = _fit_tempco_pvsyst_iec61853_sandia_2025(i_sc[is_g_stc],
+                                                          temp_cell[is_g_stc])
         i_sc_ref = float(i_sc[is_g_stc & is_t_stc].item())
         alpha_sc = mu_i_sc * i_sc_ref
 
     if beta_mp is None:
-        beta_mp = _fit_tempco_pvsyst_iec61853_sandia(v_mp[is_g_stc],
-                                                     temp_cell[is_g_stc])
+        beta_mp = _fit_tempco_pvsyst_iec61853_sandia_2025(v_mp[is_g_stc],
+                                                          temp_cell[is_g_stc])
 
-    R_sh_ref, R_sh_0, R_sh_exp = _fit_shunt_resistances_pvsyst_iec61853_sandia(
-        i_sc, i_mp, v_mp, effective_irradiance, temp_cell, beta_mp,
-        coeff=r_sh_coeff, min_irradiance=min_Rsh_irradiance
+    R_sh_ref, R_sh_0, R_sh_exp = \
+        _fit_shunt_resistances_pvsyst_iec61853_sandia_2025(
+            i_sc, i_mp, v_mp, effective_irradiance, temp_cell, beta_mp,
+            coeff=r_sh_coeff, min_irradiance=min_Rsh_irradiance
     )
 
     if R_s is None:
-        R_s = _fit_series_resistance_pvsyst_iec61853_sandia(v_oc, i_mp, v_mp)
+        R_s = _fit_series_resistance_pvsyst_iec61853_sandia_2025(v_oc, i_mp,
+                                                                 v_mp)
 
-    gamma_ref, mu_gamma = _fit_diode_ideality_factor_pvsyst_iec61853_sandia(
-        i_sc[is_t_stc], v_oc[is_t_stc], i_mp[is_t_stc], v_mp[is_t_stc],
-        effective_irradiance[is_t_stc], temp_cell[is_t_stc],
-        R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series
+    gamma_ref, mu_gamma = \
+        _fit_diode_ideality_factor_pvsyst_iec61853_sandia_2025(
+            i_sc[is_t_stc], v_oc[is_t_stc], i_mp[is_t_stc], v_mp[is_t_stc],
+            effective_irradiance[is_t_stc], temp_cell[is_t_stc],
+            R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series
     )
 
-    I_o_ref = _fit_saturation_current_pvsyst_iec61853_sandia(
+    I_o_ref = _fit_saturation_current_pvsyst_iec61853_sandia_2025(
         i_sc, v_oc, effective_irradiance, temp_cell, gamma_ref, mu_gamma,
         R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series, EgRef
     )
 
-    I_L_ref = _fit_photocurrent_pvsyst_iec61853_sandia(
+    I_L_ref = _fit_photocurrent_pvsyst_iec61853_sandia_2025(
         i_sc, effective_irradiance, temp_cell, alpha_sc,
         gamma_ref, mu_gamma,
         I_o_ref, R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series, EgRef
     )
 
     gamma_ref, mu_gamma = \
-        _fit_diode_ideality_factor_post_pvsyst_iec61853_sandia(
+        _fit_diode_ideality_factor_post_pvsyst_iec61853_sandia_2025(
             i_mp, v_mp, effective_irradiance, temp_cell, alpha_sc, I_L_ref,
             I_o_ref, R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series, EgRef)
 
@@ -475,14 +478,15 @@ def fit_pvsyst_iec61853_sandia(effective_irradiance, temp_cell,
     return fitted_params
 
 
-def _fit_tempco_pvsyst_iec61853_sandia(values, temp_cell, temp_cell_ref=25):
+def _fit_tempco_pvsyst_iec61853_sandia_2025(values, temp_cell,
+                                            temp_cell_ref=25):
     fit = np.polynomial.polynomial.Polynomial.fit(temp_cell, values, deg=1)
     intercept, slope = fit.convert().coef
     value_ref = intercept + slope*temp_cell_ref
     return slope / value_ref
 
 
-def _fit_shunt_resistances_pvsyst_iec61853_sandia(
+def _fit_shunt_resistances_pvsyst_iec61853_sandia_2025(
         i_sc, i_mp, v_mp, effective_irradiance, temp_cell,
         beta_v_mp, coeff=0.2, min_irradiance=None):
     if min_irradiance is None:
@@ -518,7 +522,7 @@ def _fit_shunt_resistances_pvsyst_iec61853_sandia(
     return Rshref, Rsh0, Rshexp
 
 
-def _fit_series_resistance_pvsyst_iec61853_sandia(v_oc, i_mp, v_mp):
+def _fit_series_resistance_pvsyst_iec61853_sandia_2025(v_oc, i_mp, v_mp):
     # Stein et al 2014, https://doi.org/10.1109/PVSC.2014.6925326
 
     # Eq 13
@@ -530,7 +534,7 @@ def _fit_series_resistance_pvsyst_iec61853_sandia(v_oc, i_mp, v_mp):
     return R_s
 
 
-def _fit_diode_ideality_factor_pvsyst_iec61853_sandia(
+def _fit_diode_ideality_factor_pvsyst_iec61853_sandia_2025(
         i_sc, v_oc, i_mp, v_mp, effective_irradiance, temp_cell,
         R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series):
 
@@ -550,7 +554,7 @@ def _fit_diode_ideality_factor_pvsyst_iec61853_sandia(
     return gamma_ref, 0
 
 
-def _fit_saturation_current_pvsyst_iec61853_sandia(
+def _fit_saturation_current_pvsyst_iec61853_sandia_2025(
         i_sc, v_oc, effective_irradiance, temp_cell, gamma_ref, mu_gamma,
         R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series, EgRef):
     R_sh = _pvsyst_Rsh(effective_irradiance, R_sh_ref, R_sh_0, R_sh_exp)
@@ -568,7 +572,7 @@ def _fit_saturation_current_pvsyst_iec61853_sandia(
     return I_o_ref
 
 
-def _fit_photocurrent_pvsyst_iec61853_sandia(
+def _fit_photocurrent_pvsyst_iec61853_sandia_2025(
         i_sc, effective_irradiance, temp_cell, alpha_sc, gamma_ref,
         mu_gamma, I_o_ref, R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series,
         EgRef):
@@ -588,7 +592,7 @@ def _fit_photocurrent_pvsyst_iec61853_sandia(
     return I_L_ref
 
 
-def _fit_diode_ideality_factor_post_pvsyst_iec61853_sandia(
+def _fit_diode_ideality_factor_post_pvsyst_iec61853_sandia_2025(
         i_mp, v_mp, effective_irradiance, temp_cell, alpha_sc, I_L_ref,
         I_o_ref, R_sh_ref, R_sh_0, R_sh_exp, R_s, cells_in_series, EgRef):
 

tests/ivtools/sdm/test_pvsyst.py

@@ -238,8 +238,8 @@ def iec61853_conditions():
     return ee, tc
 
 
-def test_fit_pvsyst_iec61853_sandia(pvsyst_iec61853_table3,
-                                    iec61853_conditions):
+def test_fit_pvsyst_iec61853_sandia_2025(pvsyst_iec61853_table3,
+                                         iec61853_conditions):
     ee, tc = iec61853_conditions
     for _, case in pvsyst_iec61853_table3.items():
         true_params = case['true']
@@ -248,7 +248,7 @@ def test_fit_pvsyst_iec61853_sandia(pvsyst_iec61853_table3,
         sde_params = pvsystem.calcparams_pvsyst(ee, tc, **true_params)
         iv = pvsystem.singlediode(*sde_params)
 
-        fitted_params = sdm.fit_pvsyst_iec61853_sandia(
+        fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(
             ee, tc, iv['i_sc'], iv['v_oc'], iv['i_mp'], iv['v_mp'],
             true_params['cells_in_series'], EgRef=true_params['EgRef'],
         )
@@ -257,8 +257,8 @@ def test_fit_pvsyst_iec61853_sandia(pvsyst_iec61853_table3,
                               atol=0, rtol=1e-3)
 
 
-def test_fit_pvsyst_iec61853_sandia_optional(pvsyst_iec61853_table3,
-                                             iec61853_conditions):
+def test_fit_pvsyst_iec61853_sandia_2025_optional(pvsyst_iec61853_table3,
+                                                  iec61853_conditions):
     # verify that modifying each optional parameter results in different output
     ee, tc = iec61853_conditions
     case = pvsyst_iec61853_table3['high current']
@@ -273,39 +273,39 @@ def test_fit_pvsyst_iec61853_sandia_optional(pvsyst_iec61853_table3,
         cells_in_series=true_params['cells_in_series']
     )
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   EgRef=1.0)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        EgRef=1.0)
     assert not np.isclose(fitted_params['I_o_ref'], expected['I_o_ref'],
                           atol=0, rtol=1e-3)
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   alpha_sc=0.5e-3)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        alpha_sc=0.5e-3)
     assert not np.isclose(fitted_params['alpha_sc'], expected['alpha_sc'],
                           atol=0, rtol=1e-3)
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   beta_mp=-1e-4)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        beta_mp=-1e-4)
     assert not np.isclose(fitted_params['R_sh_ref'], expected['R_sh_ref'],
                           atol=0, rtol=1e-3)
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   r_sh_coeff=0.3)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        r_sh_coeff=0.3)
     assert not np.isclose(fitted_params['R_sh_ref'], expected['R_sh_ref'],
                           atol=0, rtol=1e-3)
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   R_s=0.5)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        R_s=0.5)
     assert not np.isclose(fitted_params['R_s'], expected['R_s'],
                           atol=0, rtol=1e-3)
 
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**main_inputs,
-                                                   min_Rsh_irradiance=500)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**main_inputs,
+                                                        min_Rsh_irradiance=500)
     assert not np.isclose(fitted_params['R_sh_ref'], expected['R_sh_ref'],
                           atol=0, rtol=1e-3)
 
 
-def test_fit_pvsyst_iec61853_sandia_tolerance(pvsyst_iec61853_table3,
-                                              iec61853_conditions):
+def test_fit_pvsyst_iec61853_sandia_2025_tolerance(pvsyst_iec61853_table3,
+                                                   iec61853_conditions):
     # verify that the *_tolerance parameters allow non-"perfect" irradiance
     # and temperature values
     ee, tc = iec61853_conditions
@@ -322,15 +322,16 @@ def test_fit_pvsyst_iec61853_sandia_tolerance(pvsyst_iec61853_table3,
         v_oc=iv['v_oc'], i_mp=iv['i_mp'], v_mp=iv['v_mp'],
         cells_in_series=true_params['cells_in_series']
     )
-    fitted_params = sdm.fit_pvsyst_iec61853_sandia(**inputs)
+    fitted_params = sdm.fit_pvsyst_iec61853_sandia_2025(**inputs)
     # still get approximately the expected values
     for key in expected.keys():
         assert np.isclose(fitted_params[key], expected[key], atol=0, rtol=1e-2)
 
     # but if the changes exceed the specified tolerance, then error:
     with pytest.raises(ValueError, match='Coefficient array is empty'):
-        sdm.fit_pvsyst_iec61853_sandia(**inputs, irradiance_tolerance=0.1)
+        sdm.fit_pvsyst_iec61853_sandia_2025(**inputs, irradiance_tolerance=0.1)
 
     with pytest.raises(ValueError,
                        match='can only convert an array of size 1'):
-        sdm.fit_pvsyst_iec61853_sandia(**inputs, temperature_tolerance=0.1)
+        sdm.fit_pvsyst_iec61853_sandia_2025(**inputs,
+                                            temperature_tolerance=0.1)