Skip to content

Commit 041f5f0

Browse files
committed
list non-required param instead, units, formatting
1 parent 25e06cf commit 041f5f0

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Enhancements
2020
Documentation
2121
~~~~~~~~~~~~~
2222
* Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)
23-
* Documented how `np.nan` values are handled by :py:func:`~pvlib.spectrum.average_photon_energy`
23+
* Document how ``np.nan`` values are handled by :py:func:`~pvlib.spectrum.average_photon_energy`
2424
(:issue:`2423`, :pull:`2426`)
25-
* Clarify which SAPM coefficients are required by the `module` parameter in
26-
`:py:func:`~pvlib.pvsystem.sapm` (:issue:`2392`, :pull:`2435`)
25+
* Clarify which SAPM coefficients are required by the ``module`` parameter in
26+
:py:func:`~pvlib.pvsystem.sapm` (:issue:`2392`, :pull:`2435`)
2727

2828
Testing
2929
~~~~~~~

pvlib/pvsystem.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2199,16 +2199,16 @@ def sapm(effective_irradiance, temp_cell, module):
21992199
'''
22002200
The Sandia PV Array Performance Model (SAPM) generates 5 points on a
22012201
PV module's I-V curve (Voc, Isc, Ix, Ixx, Vmp/Imp) according to
2202-
SAND2004-3535. Assumes a reference cell temperature of 25 C.
2202+
SAND2004-3535. Assumes a reference cell temperature of 25°C.
22032203
22042204
Parameters
22052205
----------
22062206
effective_irradiance : numeric
22072207
Irradiance reaching the module's cells, after reflections and
2208-
adjustment for spectrum. [W/m2]
2208+
adjustment for spectrum. [Wm⁻²]
22092209
22102210
temp_cell : numeric
2211-
Cell temperature [C].
2211+
Cell temperature [°C].
22122212
22132213
module : dict-like
22142214
A dict or Series defining the SAPM parameters. See the notes section
@@ -2233,9 +2233,9 @@ def sapm(effective_irradiance, temp_cell, module):
22332233
The Sandia module database contains parameter values for a limited set
22342234
of modules. The CEC module database does not contain these parameters.
22352235
Both databases can be accessed using :py:func:`retrieve_sam`. The full list
2236-
of SAPM parameters is presented in the table below. Those that are required
2237-
in ``module`` are: `Bvmpo`, `Mbvmp`, `Bvoco`, `Mbvoc`, `N`, and
2238-
`Cells_in_Series`.
2236+
of SAPM parameters is presented in the table below. All but ``A0`` to
2237+
``A4``, ``B0`` to ``B5``, ``C4`` to ``C7``, ``IX0``, and ``IXX0`` are
2238+
required in the ``module`` parameter.
22392239
22402240
================ ========================================================
22412241
Key Description
@@ -2251,19 +2251,19 @@ def sapm(effective_irradiance, temp_cell, module):
22512251
Voco Open circuit voltage at reference condition (amps)
22522252
Vmpo Maximum power voltage at reference condition (amps)
22532253
Aisc Short circuit current temperature coefficient at
2254-
reference condition (1/C)
2254+
reference condition (1/°C)
22552255
Aimp Maximum power current temperature coefficient at
2256-
reference condition (1/C)
2256+
reference condition (1/°C)
22572257
Bvoco Open circuit voltage temperature coefficient at
2258-
reference condition (V/C)
2258+
reference condition (V/°C)
22592259
Mbvoc Coefficient providing the irradiance dependence for the
22602260
BetaVoc temperature coefficient at reference irradiance
2261-
(V/C)
2261+
(V/°C)
22622262
Bvmpo Maximum power voltage temperature coefficient at
22632263
reference condition
22642264
Mbvmp Coefficient providing the irradiance dependence for the
22652265
BetaVmp temperature coefficient at reference irradiance
2266-
(V/C)
2266+
(V/°C)
22672267
N Empirically determined "diode factor" (dimensionless)
22682268
Cells_in_Series Number of cells in series in a module's cell string(s)
22692269
IXO Ix at reference conditions

0 commit comments

Comments
 (0)