From 22612d82577b24d85202e8a0e97f2697a42b020d Mon Sep 17 00:00:00 2001 From: Will Holmgren Date: Thu, 21 Jun 2018 18:26:55 -0500 Subject: [PATCH 1/5] update modelchain docs --- docs/sphinx/source/whatsnew/v0.6.0.rst | 2 ++ pvlib/modelchain.py | 20 +++++++------------- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index 2f205edf04..0132bf0e2f 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -26,6 +26,8 @@ Documentation ~~~~~~~~~~~~~ * Expand testing section with guidelines for functions, PVSystem/Location objects, and ModelChain. +* Remove several erroneous "not yet implemented" comments from ModelChain + documentation. (:issue:``) Testing diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index 29f4cfa674..d1f3c3d172 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -220,9 +220,6 @@ class ModelChain(object): 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. - Parameters ---------- system : PVSystem @@ -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 @@ -273,9 +270,8 @@ class ModelChain(object): spectral_model: None, str, or function, default None 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. + 'first_solar', 'no_loss'. The ModelChain instance will be passed + 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 From 5bec7c9720b4c71716991616fa3dd040708e5356 Mon Sep 17 00:00:00 2001 From: Will Holmgren Date: Sat, 23 Jun 2018 13:05:09 -0700 Subject: [PATCH 2/5] reword ModelChain intro doc --- pvlib/modelchain.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index d1f3c3d172..86123fa537 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -216,9 +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. + A class to provide a high-level interface for standarized + calculations of PV power from a time series of weather inputs. Parameters ---------- From d9adb3ee93056d20d4423e080b4a264a6101fe09 Mon Sep 17 00:00:00 2001 From: Will Holmgren Date: Sat, 23 Jun 2018 13:34:28 -0700 Subject: [PATCH 3/5] make whatsnew more accurate --- docs/sphinx/source/whatsnew/v0.6.0.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index 73a9d12738..4a242d32b9 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -28,8 +28,8 @@ Documentation ~~~~~~~~~~~~~ * Expand testing section with guidelines for functions, PVSystem/Location objects, and ModelChain. -* Remove several erroneous "not yet implemented" comments from ModelChain - documentation. (:issue:``) +* Remove several erroneous statements in ModelChain documentation. + (:issue:`475`) Testing From 5440e5024725cbddebd4b78642b5110ea0b10d8b Mon Sep 17 00:00:00 2001 From: Will Holmgren Date: Sat, 23 Jun 2018 13:35:25 -0700 Subject: [PATCH 4/5] make whatsnew more accurate --- docs/sphinx/source/whatsnew/v0.6.0.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index 4a242d32b9..f6af10f928 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -28,8 +28,8 @@ Documentation ~~~~~~~~~~~~~ * Expand testing section with guidelines for functions, PVSystem/Location objects, and ModelChain. -* Remove several erroneous statements in ModelChain documentation. - (:issue:`475`) +* Updated several incorrect statements in ModelChain documentation regarding + implementation status and default values. (:issue:`475`) Testing From d6c310eb78f6a832470f9ad61ceacc6ab6408fb1 Mon Sep 17 00:00:00 2001 From: Will Holmgren Date: Sun, 24 Jun 2018 09:07:59 -0700 Subject: [PATCH 5/5] review comments --- docs/sphinx/source/whatsnew/v0.6.0.rst | 2 +- pvlib/modelchain.py | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index f6af10f928..faf82eec5b 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -29,7 +29,7 @@ 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`) + implementation status and default values. (:issue:`480`) Testing diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index 2d3c04ccdd..8db7231caa 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -216,8 +216,9 @@ def get_orientation(strategy, **kwargs): class ModelChain(object): """ - A class to provide a high-level interface for standarized - calculations of PV power from a time series of weather inputs. + 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 ----------