diff --git a/docs/sphinx/source/whatsnew/v0.10.2.rst b/docs/sphinx/source/whatsnew/v0.10.2.rst index ec9ca5891a..f399621356 100644 --- a/docs/sphinx/source/whatsnew/v0.10.2.rst +++ b/docs/sphinx/source/whatsnew/v0.10.2.rst @@ -42,6 +42,11 @@ Documentation (:issue:`1811`, :pull:`1812`) * Removed Stickler-CI integration as the service has ceased June 2023. (:issue:`1722`, :pull:`1723`) +* Specified that :py:func:`pvlib.singlediode.bishop88`, + :py:func:`pvlib.singlediode.bishop88_i_from_v`, and + :py:func:`pvlib.singlediode.bishop88_v_from_i` parameters `breakdown_factor`, + `breakdown_voltage`, and `breakdown_exp` should be floats. + (:issue:`1820`, :pull:`1821`) * Fix and update example in :py:func:`pvlib.pvsystem.retrieve_sam`. (:issue:`1741`, :pull:`1833`) * Fix error in :py:func:`pvlib.iotools.get_pvgis_hourly` documentation of `surface_azimuth`. diff --git a/pvlib/singlediode.py b/pvlib/singlediode.py index cfc63f3591..768ab7518c 100644 --- a/pvlib/singlediode.py +++ b/pvlib/singlediode.py @@ -109,13 +109,13 @@ def bishop88(diode_voltage, photocurrent, saturation_current, (a-Si) modules that is the product of the PV module number of series cells :math:`N_{s}` and the builtin voltage :math:`V_{bi}` of the intrinsic layer. [V]. - breakdown_factor : numeric, default 0 + breakdown_factor : float, default 0 fraction of ohmic current involved in avalanche breakdown :math:`a`. Default of 0 excludes the reverse bias term from the model. [unitless] - breakdown_voltage : numeric, default -5.5 + breakdown_voltage : float, default -5.5 reverse breakdown voltage of the photovoltaic junction :math:`V_{br}` [V] - breakdown_exp : numeric, default 3.28 + breakdown_exp : float, default 3.28 avalanche breakdown exponent :math:`m` [unitless] gradients : bool False returns only I, V, and P. True also returns gradients @@ -238,13 +238,13 @@ def bishop88_i_from_v(voltage, photocurrent, saturation_current, (a-Si) modules that is the product of the PV module number of series cells ``Ns`` and the builtin voltage ``Vbi`` of the intrinsic layer. [V]. - breakdown_factor : numeric, default 0 + breakdown_factor : float, default 0 fraction of ohmic current involved in avalanche breakdown :math:`a`. Default of 0 excludes the reverse bias term from the model. [unitless] - breakdown_voltage : numeric, default -5.5 + breakdown_voltage : float, default -5.5 reverse breakdown voltage of the photovoltaic junction :math:`V_{br}` [V] - breakdown_exp : numeric, default 3.28 + breakdown_exp : float, default 3.28 avalanche breakdown exponent :math:`m` [unitless] method : str, default 'newton' Either ``'newton'`` or ``'brentq'``. ''method'' must be ``'newton'`` @@ -373,13 +373,13 @@ def bishop88_v_from_i(current, photocurrent, saturation_current, (a-Si) modules that is the product of the PV module number of series cells ``Ns`` and the builtin voltage ``Vbi`` of the intrinsic layer. [V]. - breakdown_factor : numeric, default 0 + breakdown_factor : float, default 0 fraction of ohmic current involved in avalanche breakdown :math:`a`. Default of 0 excludes the reverse bias term from the model. [unitless] - breakdown_voltage : numeric, default -5.5 + breakdown_voltage : float, default -5.5 reverse breakdown voltage of the photovoltaic junction :math:`V_{br}` [V] - breakdown_exp : numeric, default 3.28 + breakdown_exp : float, default 3.28 avalanche breakdown exponent :math:`m` [unitless] method : str, default 'newton' Either ``'newton'`` or ``'brentq'``. ''method'' must be ``'newton'``