Skip to content

Commit fff1131

Browse files
authored
update incorrect statements in ModelChain documentation (#489)
* update modelchain docs * reword ModelChain intro doc * make whatsnew more accurate * make whatsnew more accurate * review comments
1 parent fe5d90d commit fff1131

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Documentation
2929
~~~~~~~~~~~~~
3030
* Expand testing section with guidelines for functions, PVSystem/Location
3131
objects, and ModelChain.
32+
* Updated several incorrect statements in ModelChain documentation regarding
33+
implementation status and default values. (:issue:`480`)
3234

3335

3436
Testing

pvlib/modelchain.py

+9-15
Original file line numberDiff line numberDiff line change
@@ -216,12 +216,9 @@ def get_orientation(strategy, **kwargs):
216216

217217
class ModelChain(object):
218218
"""
219-
An experimental class that represents all of the modeling steps
220-
necessary for calculating power or energy for a PV system at a given
221-
location using the SAPM.
222-
223-
CEC module specifications and the single diode model are not yet
224-
supported.
219+
The ModelChain class to provides a standardized, high-level
220+
interface for all of the modeling steps necessary for calculating PV
221+
power from a time series of weather inputs.
225222
226223
Parameters
227224
----------
@@ -233,7 +230,7 @@ class ModelChain(object):
233230
A :py:class:`~pvlib.location.Location` object that represents
234231
the physical location at which to evaluate the model.
235232
236-
orientation_strategy : None or str, default 'south_at_latitude_tilt'
233+
orientation_strategy : None or str, default None
237234
The strategy for aligning the modules. If not None, sets the
238235
``surface_azimuth`` and ``surface_tilt`` properties of the
239236
``system``. Allowed strategies include 'flat',
@@ -260,9 +257,9 @@ class ModelChain(object):
260257
ac_model: None, str, or function, default None
261258
If None, the model will be inferred from the contents of
262259
system.inverter_parameters and system.module_parameters. Valid
263-
strings are 'snlinverter', 'adrinverter' (not implemented),
264-
'pvwatts'. The ModelChain instance will be passed as the first
265-
argument to a user-defined function.
260+
strings are 'snlinverter', 'adrinverter', 'pvwatts'. The
261+
ModelChain instance will be passed as the first argument to a
262+
user-defined function.
266263
267264
aoi_model: None, str, or function, default None
268265
If None, the model will be inferred from the contents of
@@ -274,8 +271,7 @@ class ModelChain(object):
274271
If None, the model will be inferred from the contents of
275272
system.module_parameters. Valid strings are 'sapm',
276273
'first_solar', 'no_loss'. The ModelChain instance will be passed
277-
as the first argument to a user-defined
278-
function.
274+
as the first argument to a user-defined function.
279275
280276
temp_model: str or function, default 'sapm'
281277
Valid strings are 'sapm'. The ModelChain instance will be passed
@@ -301,9 +297,7 @@ def __init__(self, system, location,
301297
airmass_model='kastenyoung1989',
302298
dc_model=None, ac_model=None, aoi_model=None,
303299
spectral_model=None, temp_model='sapm',
304-
losses_model='no_loss',
305-
name=None,
306-
**kwargs):
300+
losses_model='no_loss', name=None, **kwargs):
307301

308302
self.name = name
309303
self.system = system

0 commit comments

Comments
 (0)