changes from review

Author: kandersolar

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

@@ -17,7 +17,7 @@ Functions relevant for single diode models.
    pvsystem.v_from_i
    pvsystem.max_power_point
    ivtools.sdm.pvsyst_temperature_coeff
-   singlediode.batzelis_keypoints
+   singlediode.batzelis
 
 Low-level functions for solving the single diode equation.
 

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

@@ -20,7 +20,7 @@ Enhancements
 ~~~~~~~~~~~~
 * Add :py:func:`~pvlib.ivtools.sdm.fit_desoto_batzelis`, a function to estimate
   parameters for the De Soto single-diode model from datasheet values. (:pull:`2563`)
-* Add :py:func:`~pvlib.singlediode.batzelis_keypoints`, a function to estimate
+* Add :py:func:`~pvlib.singlediode.batzelis`, a function to estimate
   maximum power, open circuit, and short circuit points using parameters for
   the single-diode equation. (:pull:`2563`)
 * Add :py:func:`~pvlib.pvarray.batzelis`, a function to estimate maximum power

pvlib/singlediode.py

@@ -952,8 +952,8 @@ def _pwr_optfcn(df, loc):
     return current * df[loc]
 
 
-def batzelis_keypoints(photocurrent, saturation_current, resistance_series,
-                       resistance_shunt, nNsVth):
+def batzelis(photocurrent, saturation_current, resistance_series,
+             resistance_shunt, nNsVth):
     """
     Estimate maximum power, open-circuit, and short-circuit points from
     single-diode equation parameters using Batzelis's method.

tests/test_singlediode.py

@@ -8,7 +8,7 @@
 from pvlib import pvsystem
 from pvlib.singlediode import (bishop88_mpp, estimate_voc, VOLTAGE_BUILTIN,
                                bishop88, bishop88_i_from_v, bishop88_v_from_i,
-                               batzelis_keypoints)
+                               batzelis)
 import pytest
 from numpy.testing import assert_array_equal
 from .conftest import TESTS_DATA_DIR
@@ -626,7 +626,7 @@ def test_bishop88_init_cond(method):
     assert not bad_results.any()
 
 
-def test_batzelis_keypoints():
+def test_batzelis():
     params = {'photocurrent': 10, 'saturation_current': 1e-10,
               'resistance_series': 0.2, 'resistance_shunt': 3000,
               'nNsVth': 1.7}
@@ -640,37 +640,38 @@ def test_batzelis_keypoints():
     }
     rtol = 5e-3  # accurate to within half a percent in this case
 
-    output = batzelis_keypoints(**params)
+    output = batzelis(**params)
     for key in exact_values:
         assert output[key] == pytest.approx(exact_values[key], rel=rtol)
 
     # numpy arrays
     params2 = {k: np.array([v] * 2) for k, v in params.items()}
-    output2 = batzelis_keypoints(**params2)
+    output2 = batzelis(**params2)
     for key in exact_values:
         exp = np.array([exact_values[key]] * 2)
         np.testing.assert_allclose(output2[key], exp, rtol=rtol)
 
     # pandas
     params3 = {k: pd.Series(v) for k, v in params2.items()}
-    output3 = batzelis_keypoints(**params3)
+    output3 = batzelis(**params3)
     assert isinstance(output3, pd.DataFrame)
     for key in exact_values:
         exp = pd.Series([exact_values[key]] * 2)
         np.testing.assert_allclose(output3[key], exp, rtol=rtol)
 
 
-def test_batzelis_keypoints_night():
-    # SDMs produce photocurrent=0 and resistance_shunt=inf at night
-    out = batzelis_keypoints(photocurrent=0, saturation_current=1e-10,
-                             resistance_series=0.2, resistance_shunt=np.inf,
-                             nNsVth=1.7)
+def test_batzelis_night():
+    # The De Soto SDM produces photocurrent=0 and resistance_shunt=inf
+    # at 0 W/m2 irradiance
+    out = batzelis(photocurrent=0, saturation_current=1e-10,
+                   resistance_series=0.2, resistance_shunt=np.inf,
+                   nNsVth=1.7)
     for k, v in out.items():
         assert v == 0, k  # ensure all outputs are zero (not nan, etc)
 
     # test also when Rsh=inf but Iph > 0
-    out = batzelis_keypoints(photocurrent=0.1, saturation_current=1e-10,
-                             resistance_series=0.2, resistance_shunt=np.inf,
-                             nNsVth=1.7)
+    out = batzelis(photocurrent=0.1, saturation_current=1e-10,
+                   resistance_series=0.2, resistance_shunt=np.inf,
+                   nNsVth=1.7)
     for k, v in out.items():
         assert v > 0, k  # ensure all outputs >0 (not nan, etc)