Model chains

docs/notebook_requirements.txt

@@ -34,7 +34,6 @@ pyzmq==17.1.0
 qtconsole==4.3.1
 Send2Trash==1.5.0
 simplegeneric==0.8.1
-tables==3.6.1
 terminado==0.8.1
 testpath==0.3.1
 tornado==5.1

docs/sphinx/source/TrendAnalysis_example.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../TrendAnalysis_example_pvdaq4.ipynb"
+}

docs/sphinx/source/api.rst

@@ -14,6 +14,7 @@ analysis workflow.
 .. autosummary::
    :toctree: generated/
 
+   analysis_chains
    degradation
    soiling   
    availability
@@ -23,7 +24,25 @@ analysis workflow.
    clearsky_temperature
    plotting
 
+Analysis Chains
+===============
 
+Object-oriented end-to-end analysis
+
+.. autosummary::
+   :toctree: generated/
+
+   analysis_chains.TrendAnalysis
+   analysis_chains.TrendAnalysis.set_clearsky
+   analysis_chains.TrendAnalysis.sensor_analysis
+   analysis_chains.TrendAnalysis.clearsky_analysis
+   analysis_chains.TrendAnalysis.plot_degradation_summary
+   analysis_chains.TrendAnalysis.plot_soiling_rate_histogram
+   analysis_chains.TrendAnalysis.plot_soiling_interval
+   analysis_chains.TrendAnalysis.plot_soiling_monte_carlo
+   analysis_chains.TrendAnalysis.plot_pv_vs_irradiance
+
+
 Degradation
 ===========
 

docs/sphinx/source/changelog.rst

@@ -1,8 +1,10 @@
 RdTools Change Log
 ==================
 
+.. include:: changelog/v2.1.0-beta.0.rst
 .. include:: changelog/v2.0.2.rst
 .. include:: changelog/v2.0.1.rst
 .. include:: changelog/v2.0.0.rst
 .. include:: changelog/pre_2.0.0.rst
 
+

docs/sphinx/source/changelog/v2.1.0-beta.0.rst

@@ -0,0 +1,52 @@
+*********************************
+v2.1.0-beta.0 (November XX, 2020)
+*********************************
+
+API Changes
+-----------
+* Add :py:class:`~rdtools.analysis_chains.TrendAnalysis` class for single-line analysis. (:pull:`117`).
+
+Enhancements
+------------
+* Add new :py:mod:`~rdtools.analysis_chains` module to focus on single-line analysis workflow
+  (:pull:`117`).
+* Add :py:class:`~rdtools.analysis_chains.TrendAnalysis` class for single-line analysis. 
+  Degradation analysis is run by :py:meth:`~rdtools.analysis_chains.TrendAnalysis.sensor_analysis` 
+  and :py:meth:`~rdtools.analysis_chains.TrendAnalysis.clearsky_analysis`. Soiling analysis
+  is run by including 'srr_soiling' option when calling 
+  :py:meth:`~rdtools.analysis_chains.TrendAnalysis.sensor_analysis` (:pull:`117`).
+
+
+Bug fixes
+---------
+
+
+Testing
+-------
+* Complete testing for functions and plotting of :py:mod:`~rdtools.analysis_chains` module (:pull:`196`).
+
+
+Documentation
+-------------
+* :py:class:`~rdtools.analysis_chains.TrendAnalysis` 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_chains.TrendAnalysis`
+  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`)

docs/sphinx/source/index.rst

@@ -28,7 +28,7 @@ Full examples are worked out in the example notebooks in the
 To report issues, contribute code, or suggest improvements to this
 documentation, visit the RdTools development repository on `github`_.
 
-Degradation and Soiling
+Trends
 -----------------------
 
 Both degradation and soiling analyses are based on normalized yield, similar to performance
@@ -98,6 +98,13 @@ identified soiling rates for the dataset.
    :width: 320
    :height: 216
 
+TrendAnalysis
+^^^^^^^^^^^^^
+An object-oriented API for complete soiling and degradation analysis including 
+the normalize, filter, aggregate, analyze steps is available in
+:py:class:`.analysis_chains.TrendAnalysis`. See the `TrendAnalysis example`_ 
+for details. 
+
 Availability
 ------------
 
@@ -285,6 +292,7 @@ Documentation Contents
    :maxdepth: 2
 
    Degradation and Soiling <rd_example>
+   TrendAnalysis <TrendAnalysis_example>
    Inverter Downtime <system_availability_example>
    API Reference <api>
    Change Log <changelog>
@@ -299,7 +307,7 @@ Indices and tables
 
 
 .. links and references
-
+.. _TrendAnalysis example: TrendAnalysis_example.nblink 
 .. _example notebook: rd_example.nblink
 .. _release: https://github.com/NREL/rdtools/releases
 .. _github: https://github.com/NREL/rdtools

rdtools/__init__.py

@@ -14,9 +14,10 @@
 from rdtools.filtering import tcell_filter
 from rdtools.filtering import clip_filter
 from rdtools.filtering import normalized_filter
-# from rdtools.soiling import soiling_srr
-# from rdtools.soiling import monthly_soiling_rates
-# from rdtools.soiling import annual_soiling_ratios
+#from rdtools.soiling import soiling_srr
+#from rdtools.soiling import monthly_soiling_rates
+#from rdtools.soiling import annual_soiling_ratios
+from rdtools.analysis_chains import TrendAnalysis 
 from rdtools.plotting import degradation_summary_plots
 # from rdtools.plotting import soiling_monte_carlo_plot
 # from rdtools.plotting import soiling_interval_plot