Skip to content

fix snlinverter and singlediode documentation #189

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.

Sign up for GitHub

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 1 commit into from
Jun 10, 2016
Merged

fix snlinverter and singlediode documentation #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/sphinx/source/whatsnew/v0.3.3.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Bug fixes
* Fix another bug with the Appveyor continuous integration builds.
(:issue:`170`)
* Add classifiers to setup.py. (:issue:`181`)
* Fix snlinverter and singlediode documentation. They incorrectly said that
inverter/module must be a DataFrame, when in reality they can be any
dict-like object. (:issue:`157`)


Documentation
Expand Down
14 changes: 7 additions & 7 deletions pvlib/pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def __init__(self,

# needed for tying together Location and PVSystem in LocalizedPVSystem
super(PVSystem, self).__init__(**kwargs)

def __repr__(self):
return ('PVSystem with tilt:' + str(self.surface_tilt) +
' and azimuth: ' + str(self.surface_azimuth) +
Expand Down Expand Up @@ -443,7 +443,7 @@ def __init__(self, pvsystem=None, location=None, **kwargs):

# get and combine attributes from the pvsystem and/or location
# with the rest of the kwargs

if pvsystem is not None:
pv_dict = pvsystem.__dict__
else:
Expand All @@ -459,7 +459,7 @@ def __init__(self, pvsystem=None, location=None, **kwargs):
list(kwargs.items()))

super(LocalizedPVSystem, self).__init__(**new_kwargs)

def __repr__(self):
return ('LocalizedPVSystem with tilt:' + str(self.surface_tilt) +
' and azimuth: ' + str(self.surface_azimuth) +
Expand Down Expand Up @@ -1323,8 +1323,8 @@ def singlediode(module, photocurrent, saturation_current,

Parameters
----------
module : DataFrame
A DataFrame defining the SAPM performance parameters.
module : dict or Series
A dict-like object defining the SAPM performance parameters.

photocurrent : float or Series
Light-generated current (photocurrent) in amperes under desired
Expand Down Expand Up @@ -1625,8 +1625,8 @@ def snlinverter(inverter, v_dc, p_dc):

Parameters
----------
inverter : DataFrame
A DataFrame defining the inverter to be used, giving the
inverter : dict or Series
A dict-like object defining the inverter to be used, giving the
inverter performance parameters according to the Sandia
Grid-Connected Photovoltaic Inverter Model (SAND 2007-5036) [1].
A set of inverter performance parameters are provided with
Expand Down