diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 84f9a90395..957e5d755f 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -30,8 +30,10 @@ Enhancements Documentation ~~~~~~~~~~~~~ * Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`) -* Documented how `np.nan` values are handled by :py:func:`~pvlib.spectrum.average_photon_energy` +* Document how ``np.nan`` values are handled by :py:func:`~pvlib.spectrum.average_photon_energy` (:issue:`2423`, :pull:`2426`) +* Clarify which SAPM coefficients are required by the ``module`` parameter in + :py:func:`~pvlib.pvsystem.sapm` (:issue:`2392`, :pull:`2435`) * Update references in :py:func`~pvlib.irradiance.get_extra_radiation` (:issue:`2333`, :pull:`2347`) diff --git a/pvlib/pvsystem.py b/pvlib/pvsystem.py index 9e96111af5..0549d475fe 100644 --- a/pvlib/pvsystem.py +++ b/pvlib/pvsystem.py @@ -2235,12 +2235,25 @@ def sapm(effective_irradiance, temp_cell, module, *, temperature_ref=25, Notes ----- - The SAPM parameters which are required in ``module`` are - listed in the following table. - The Sandia module database contains parameter values for a limited set of modules. The CEC module database does not contain these parameters. - Both databases can be accessed using :py:func:`retrieve_sam`. + Both databases can be accessed using :py:func:`retrieve_sam`. The full list + of SAPM parameters is presented in the table below. Those that are required + in the ``module`` parameter to run this model are as follows: + + * ``C0``, ``C1``, ``C2``, ``C3`` + * ``Isco`` + * ``Impo`` + * ``Voco`` + * ``Vmpo`` + * ``Aisc`` + * ``Aimp`` + * ``Bvoco`` + * ``Mbvoc`` + * ``Bvmpo`` + * ``Mbvmp`` + * ``N`` + * ``Cells_in_series`` ================ ======================================================== Key Description