Skip to content

Commit e8635d0

Browse files
authored
fix snlinverter and singlediode documentation (#189)
1 parent 14d8ad5 commit e8635d0

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

docs/sphinx/source/whatsnew/v0.3.3.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Bug fixes
3232
* Fix another bug with the Appveyor continuous integration builds.
3333
(:issue:`170`)
3434
* Add classifiers to setup.py. (:issue:`181`)
35+
* Fix snlinverter and singlediode documentation. They incorrectly said that
36+
inverter/module must be a DataFrame, when in reality they can be any
37+
dict-like object. (:issue:`157`)
3538

3639

3740
Documentation

pvlib/pvsystem.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ def __init__(self,
139139

140140
# needed for tying together Location and PVSystem in LocalizedPVSystem
141141
super(PVSystem, self).__init__(**kwargs)
142-
142+
143143
def __repr__(self):
144144
return ('PVSystem with tilt:' + str(self.surface_tilt) +
145145
' and azimuth: ' + str(self.surface_azimuth) +
@@ -443,7 +443,7 @@ def __init__(self, pvsystem=None, location=None, **kwargs):
443443

444444
# get and combine attributes from the pvsystem and/or location
445445
# with the rest of the kwargs
446-
446+
447447
if pvsystem is not None:
448448
pv_dict = pvsystem.__dict__
449449
else:
@@ -459,7 +459,7 @@ def __init__(self, pvsystem=None, location=None, **kwargs):
459459
list(kwargs.items()))
460460

461461
super(LocalizedPVSystem, self).__init__(**new_kwargs)
462-
462+
463463
def __repr__(self):
464464
return ('LocalizedPVSystem with tilt:' + str(self.surface_tilt) +
465465
' and azimuth: ' + str(self.surface_azimuth) +
@@ -1323,8 +1323,8 @@ def singlediode(module, photocurrent, saturation_current,
13231323
13241324
Parameters
13251325
----------
1326-
module : DataFrame
1327-
A DataFrame defining the SAPM performance parameters.
1326+
module : dict or Series
1327+
A dict-like object defining the SAPM performance parameters.
13281328
13291329
photocurrent : float or Series
13301330
Light-generated current (photocurrent) in amperes under desired
@@ -1625,8 +1625,8 @@ def snlinverter(inverter, v_dc, p_dc):
16251625
16261626
Parameters
16271627
----------
1628-
inverter : DataFrame
1629-
A DataFrame defining the inverter to be used, giving the
1628+
inverter : dict or Series
1629+
A dict-like object defining the inverter to be used, giving the
16301630
inverter performance parameters according to the Sandia
16311631
Grid-Connected Photovoltaic Inverter Model (SAND 2007-5036) [1].
16321632
A set of inverter performance parameters are provided with

0 commit comments

Comments
 (0)