diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index 9513424e1f..faf82eec5b 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -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:`480`) Testing diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index 684bf4320b..8db7231caa 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -216,12 +216,9 @@ 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. + The ModelChain class to provides a standardized, high-level + interface for all of the modeling steps necessary for calculating PV + power from a time series of weather inputs. Parameters ---------- @@ -233,7 +230,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', @@ -260,9 +257,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 @@ -274,8 +271,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 @@ -301,9 +297,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