Modelchain pytests

docs/degradation_and_soiling_example.ipynb

@@ -826,7 +826,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.7"
+   "version": "3.7.4"
   }
  },
  "nbformat": 4,

docs/sphinx/source/api.rst

@@ -14,6 +14,7 @@ analysis workflow.
 .. autosummary::
    :toctree: generated/
 
+   analysis
    degradation
    soiling   
    filtering
@@ -22,7 +23,24 @@ analysis workflow.
    clearsky_temperature
    plotting
 
+Analysis
+===========
+
+Conduct end-to-end Degradation and Soiling analysis with sensor_analysis or clearsky_analysis
+
+.. autosummary::
+   :toctree: generated/
 
+   analysis.RdAnalysis
+   analysis.RdAnalysis.sensor_analysis
+   analysis.RdAnalysis.clearsky_analysis
+   analysis.RdAnalysis.plot_degradation_summary
+   analysis.RdAnalysis.plot_soiling_rate_histogram
+   analysis.RdAnalysis.plot_soiling_interval
+   analysis.RdAnalysis.plot_soiling_monte_carlo
+   analysis.RdAnalysis.plot_pv_vs_irradiance
+
+
 Degradation
 ===========
 

docs/sphinx/source/changelog.rst

@@ -1,4 +1,6 @@
 RdTools Change Log
 ==================
 
+.. include:: changelog/v2.1.0.rst
 .. include:: changelog/v2.0.0b0.rst
+

docs/sphinx/source/changelog/v2.1.0.rst

@@ -0,0 +1,54 @@
+**************************
+v2.1.0 (October XX, 2020)
+**************************
+
+API Changes
+-----------
+* Add :py:class:`~rdtools.analysis.RdAnalysis` class for single-line analysis. (:pull:`117`).
+
+
+Enhancements
+------------
+* Add new :py:mod:`~rdtools.analysis` module to focus on single-line analysis workflow
+  (:pull:`117`).
+* Add :py:class:`~rdtools.analysis.RdAnalysis` class for single-line analysis. 
+  Degradataion analysis is run by :py:meth:`~rdtools.analysis.RdAnalysis.sensor_analysis` 
+  and :py:meth:`~rdtools.analysis.RdAnalysis.clearsky_analysis`. Soiling analysis
+  is run by including 'srr_soiling' option when calling 
+  :py:meth:`~rdtools.analysis.RdAnalysis.sensor_analysis` (:pull:`117`).
+
+
+Bug fixes
+---------
+
+
+Testing
+-------
+* Complete testing for functions and plotting of :py:mod:`~rdtools.analysis` module (:pull:`196`).
+
+
+Documentation
+-------------
+* :py:class:`~rdtools.analysis.RdAnalysis` docstrings (:pull:`117`).
+
+
+Requirements
+------------
+* tables=3.6.1 now added to requirements.txt and setup.py (:pull:`196`).
+
+Example Updates
+---------------
+* New example notebook based on PVDAQ system #4 for the new :py:class:`~rdtools.analysis.RdAnalysis`
+  analysis workflow (:pull:`196`).
+* Update the standard PVDAQ system #4 workbook to match best practice, including 
+  `pvlib.get_total_irradiance()` and `max_timedelta = '15T'` in rdtools.interpolate (:pull:`196`).
+* Update the standard PVDAQ system #4 workbook to include a single `soiling * ac_power`
+  analysis (:pull:`196`).
+
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Kevin Anderson (:ghuser:`kanderso-nrel`)
+* Chris Deline (:ghuser:`cdeline`)
+

rdtools/__init__.py

@@ -15,7 +15,7 @@
 from rdtools.filtering import clip_filter
 from rdtools.filtering import normalized_filter
 from rdtools.soiling import soiling_srr
-from rdtools.system_analysis import SystemAnalysis
+from rdtools.analysis import RdAnalysis 
 from rdtools.plotting import degradation_summary_plots
 from rdtools.plotting import soiling_monte_carlo_plot
 from rdtools.plotting import soiling_interval_plot

rdtools/system_analysis.py → rdtools/analysis.py

@@ -5,18 +5,15 @@
 import pandas as pd
 import numpy as np
 import matplotlib.pyplot as plt
-from . import normalization
-from . import filtering
-from . import aggregation
-from . import degradation
-from . import soiling
-from . import clearsky_temperature
-from . import plotting
+from rdtools import normalization, filtering, aggregation, degradation
+from rdtools import soiling, clearsky_temperature, plotting
 
 
-class SystemAnalysis():
+
+class RdAnalysis():
     '''
-    Class for end-to-end analysis
+    Class for end-to-end degradation and soiling analysis using :py:meth:`~rdtools.RdAnalysis.sensor_analysis`
+    or :py:meth:`~rdtools.RdAnalysis.clearsky_analysis`
 
     Parameters
     ----------
@@ -207,27 +204,32 @@ def calc_cell_temperature(self, poa, windspeed, ambient_temperature):
         numeric
             calculated cell temperature
         '''
-        if self.temperature_model is None:
-            cell_temp = pvlib.pvsystem.sapm_celltemp(poa_global=poa, 
-                                                     wind_speed=windspeed, 
-                                                     temp_air=ambient_temperature)
-        else:
-            #pvlib 0.7+
-            try:
-                model_params = pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS['sapm'][self.temperature_model]
-                cell_temp = pvlib.temperature.sapm_cell(poa_global=poa,
-                                                        temp_air=ambient_temperature,
-                                                        wind_speed=windspeed,
-                                                        a=model_params['a'],
-                                                        b=model_params['b'],
-                                                        deltaT=model_params['deltaT']
-                                                        )
-            except: #pvlib < 0.7
-                cell_temp = pvlib.pvsystem.sapm_celltemp(poa_global=poa, wind_speed=windspeed, 
-                                                         temp_air=ambient_temperature, 
-                                                         model=self.temperature_model)
-                cell_temp = cell_temp['temp_cell']
 
+        try:  # workflow for pvlib >= 0.7  
+
+            if self.temperature_model is None:
+                self.temperature_model = "open_rack_glass_polymer" # default
+
+            # check if self.temperature_model is a string or dict with keys 'a', 'b' and 'deltaT'
+            if isinstance(self.temperature_model,str):
+                model_params = pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS['sapm'][self.temperature_model]
+            elif (isinstance(self.temperature_model,dict) & 
+                  ('a' in self.temperature_model) & 
+                  ('b' in self.temperature_model) & 
+                  ('deltaT' in self.temperature_model)):
+                model_params = self.temperature_model
+            else:
+                raise Exception('pvlib temperature_model entry is neither '
+                                'a string nor a dictionary with correct '
+                                'entries. Try "open_rack_glass_polymer"')
+            cell_temp = pvlib.temperature.sapm_cell(poa_global=poa,
+                                                    temp_air=ambient_temperature,
+                                                    wind_speed=windspeed,
+                                                    **model_params
+                                                    )
+        except AttributeError as e:
+            print('Error: PVLib > 0.7 required')
+            raise e
         return cell_temp
 
     def calc_clearsky_tamb(self):
@@ -261,6 +263,7 @@ def pvwatts_norm(self, poa, cell_temperature):
         pandas.Series
             Associated insolation
         '''
+        import warnings
         if self.pv_nameplate is None:
             renorm = True
             pv_nameplate = 1.0
@@ -269,26 +272,27 @@ def pvwatts_norm(self, poa, cell_temperature):
             pv_nameplate = self.pv_nameplate
 
         if self.temperature_coefficient is None:
-            raise ValueError('Temperature coeffcient must be available to perform pvwatts_norm')
-
+            #raise ValueError('Temperature coefficient must be available to perform pvwatts_norm')
+            warnings.warn('Temperature coefficient not passed in to RdAnalysis'
+                          '. No temperature correction will be conducted.')
         pvwatts_kws = {"poa_global": poa,
-                       "P_ref": pv_nameplate,
-                       "T_cell": cell_temperature,
-                       "G_ref": 1000,
-                       "T_ref": 25,
+                       "power_dc_rated": pv_nameplate,
+                       "temperature_cell": cell_temperature,
+                       "poa_global_ref": 1000,
+                       "temperature_cell_ref": 25,
                        "gamma_pdc": self.temperature_coefficient}
 
-        normalized, insolation = normalization.normalize_with_pvwatts(self.pv_energy, pvwatts_kws)
+        energy_normalized, insolation = normalization.normalize_with_pvwatts(self.pv_energy, pvwatts_kws)
 
         if renorm:
             # Normalize to the 95th percentile for convenience, this is renormalized out
             # in the calculations but is relevant to normalized_filter()
-            x = normalized[np.isfinite(normalized)]
-            normalized = normalized / x.quantile(0.95)
+            x = energy_normalized[np.isfinite(energy_normalized)]
+            energy_normalized = energy_normalized / x.quantile(0.95)
 
-        return normalized, insolation
+        return energy_normalized, insolation
 
-    def filter(self, normalized, case):
+    def filter(self, energy_normalized, case):
         '''
         Calculate filters based on those in rdtools.filtering. Uses
         self.filter_params, which is a dict, the keys of which are names of
@@ -298,7 +302,7 @@ def filter(self, normalized, case):
 
         Parameters
         ----------
-        normalized : pandas.Series
+        energy_normalized : pandas.Series
             Time series of normalized PV energy
         case : str
             'sensor' or 'clearsky' which filtering protocol to apply. Affects
@@ -319,7 +323,7 @@ def filter(self, normalized, case):
             cell_temp = self.clearsky_cell_temperature
 
         if 'normalized_filter' in self.filter_params.keys():
-            f = filtering.normalized_filter(normalized, **self.filter_params['normalized_filter'])
+            f = filtering.normalized_filter(energy_normalized, **self.filter_params['normalized_filter'])
             bool_filter = bool_filter & f
         if 'poa_filter' in self.filter_params.keys():
             if poa is None:
@@ -351,7 +355,7 @@ def filter(self, normalized, case):
         elif case == 'clearsky':
             self.clearsky_filter = bool_filter
 
-    def aggregate(self, normalized, insolation):
+    def aggregate(self, energy_normalized, insolation):
         '''
         Return insolation-weighted normalized PV energy and the associated aggregated insolation
 
@@ -369,7 +373,7 @@ def aggregate(self, normalized, insolation):
         pandas.Series
             Aggregated insolation
         '''
-        aggregated = aggregation.aggregation_insol(normalized, insolation, self.aggregation_freq)
+        aggregated = aggregation.aggregation_insol(energy_normalized, insolation, self.aggregation_freq)
         aggregated_insolation = insolation.resample(self.aggregation_freq).sum()
 
         return aggregated, aggregated_insolation
@@ -453,9 +457,9 @@ def sensor_preprocess(self):
             raise ValueError('either cell or ambient temperature must be available to perform sensor_preprocess')
         if self.cell_temperature is None:
             self.cell_temperature = self.calc_cell_temperature(self.poa, self.windspeed, self.ambient_temperature)
-        normalized, insolation = self.pvwatts_norm(self.poa, self.cell_temperature)
-        self.filter(normalized, 'sensor')
-        aggregated, aggregated_insolation = self.aggregate(normalized[self.sensor_filter], insolation[self.sensor_filter])
+        energy_normalized, insolation = self.pvwatts_norm(self.poa, self.cell_temperature)
+        self.filter(energy_normalized, 'sensor')
+        aggregated, aggregated_insolation = self.aggregate(energy_normalized[self.sensor_filter], insolation[self.sensor_filter])
         self.sensor_aggregated_performance = aggregated
         self.sensor_aggregated_insolation = aggregated_insolation