Skip to content

Commit a8ab9aa

Browse files
authored
Drop DataFrame as option for module input to pvsystem.sapm (#811)
* update docstring for pvsystem.sapm * update whatsnew * minor edit
1 parent a9ebd92 commit a8ab9aa

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,9 @@ Documentation
142142
~~~~~~~~~~~~~
143143
* Corrected docstring for `pvsystem.PVSystem.sapm`
144144
* Fixed broken ipython examples from CEC data updates
145+
* Edited docstring for `pvsystem.sapm` to remove DataFrame option for input
146+
`module`. The DataFrame option was never tested and would cause an error if
147+
used. (:issue:`785`)
145148

146149
Removal of prior version deprecations
147150
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

pvlib/pvsystem.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1586,8 +1586,8 @@ def sapm(effective_irradiance, temp_cell, module):
15861586
The cell temperature (degrees C).
15871587
15881588
module : dict-like
1589-
A dict, Series, or DataFrame defining the SAPM performance
1590-
parameters. See the notes section for more details.
1589+
A dict or Series defining the SAPM parameters. See the notes section
1590+
for more details.
15911591
15921592
Returns
15931593
-------
@@ -1605,11 +1605,11 @@ def sapm(effective_irradiance, temp_cell, module):
16051605
16061606
Notes
16071607
-----
1608-
The coefficients from SAPM which are required in ``module`` are
1608+
The SAPM parameters which are required in ``module`` are
16091609
listed in the following table.
16101610
1611-
The modules in the Sandia module database contain these
1612-
coefficients, but the modules in the CEC module database do not.
1611+
The Sandia module database contains parameter values for a limited set
1612+
of modules. The CEC module database does not contain these parameters.
16131613
Both databases can be accessed using :py:func:`retrieve_sam`.
16141614
16151615
================ ========================================================

0 commit comments

Comments
 (0)