Skip to content

update incorrect statements in ModelChain documentation #489

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 6 commits into from
Jun 26, 2018
Merged

update incorrect statements in ModelChain documentation #489

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
22612d8
update modelchain docs
wholmgren Jun 21, 2018
5bec7c9
reword ModelChain intro doc
wholmgren Jun 23, 2018
b3775f9
merge master into branch
wholmgren Jun 23, 2018
d9adb3e
make whatsnew more accurate
wholmgren Jun 23, 2018
5440e50
make whatsnew more accurate
wholmgren Jun 23, 2018
d6c310e
review comments
wholmgren Jun 24, 2018
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
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.6.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Documentation
~~~~~~~~~~~~~
* Expand testing section with guidelines for functions, PVSystem/Location
objects, and ModelChain.
* Updated several incorrect statements in ModelChain documentation regarding
implementation status and default values. (:issue:`475`)


Testing
Expand Down
23 changes: 8 additions & 15 deletions pvlib/modelchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,8 @@ def get_orientation(strategy, **kwargs):

class ModelChain(object):
"""
An experimental class that represents all of the modeling steps
necessary for calculating power or energy for a PV system at a given
location using the SAPM.

CEC module specifications and the single diode model are not yet
supported.
A class to provide a high-level interface for standarized
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep the 'all of the modeling steps' language here

calculations of PV power from a time series of weather inputs.

Parameters
----------
Expand All @@ -233,7 +229,7 @@ class ModelChain(object):
A :py:class:`~pvlib.location.Location` object that represents
the physical location at which to evaluate the model.

orientation_strategy : None or str, default 'south_at_latitude_tilt'
orientation_strategy : None or str, default None
The strategy for aligning the modules. If not None, sets the
``surface_azimuth`` and ``surface_tilt`` properties of the
``system``. Allowed strategies include 'flat',
Expand All @@ -260,9 +256,9 @@ class ModelChain(object):
ac_model: None, str, or function, default None
If None, the model will be inferred from the contents of
system.inverter_parameters and system.module_parameters. Valid
strings are 'snlinverter', 'adrinverter' (not implemented),
'pvwatts'. The ModelChain instance will be passed as the first
argument to a user-defined function.
strings are 'snlinverter', 'adrinverter', 'pvwatts'. The
ModelChain instance will be passed as the first argument to a
user-defined function.

aoi_model: None, str, or function, default None
If None, the model will be inferred from the contents of
Expand All @@ -274,8 +270,7 @@ class ModelChain(object):
If None, the model will be inferred from the contents of
system.module_parameters. Valid strings are 'sapm',
'first_solar', 'no_loss'. The ModelChain instance will be passed
as the first argument to a user-defined
function.
as the first argument to a user-defined function.

temp_model: str or function, default 'sapm'
Valid strings are 'sapm'. The ModelChain instance will be passed
Expand All @@ -301,9 +296,7 @@ def __init__(self, system, location,
airmass_model='kastenyoung1989',
dc_model=None, ac_model=None, aoi_model=None,
spectral_model=None, temp_model='sapm',
losses_model='no_loss',
name=None,
**kwargs):
losses_model='no_loss', name=None, **kwargs):

self.name = name
self.system = system
Expand Down