Skip to content

Clarify which SAPM parameters are required by module in pvsystem.sapm #2435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 23, 2025
4 changes: 3 additions & 1 deletion docs/sphinx/source/whatsnew/v0.12.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,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`)

Requirements
~~~~~~~~~~~~
Expand Down
21 changes: 17 additions & 4 deletions pvlib/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading