Merge branch 'development' into patch_development_with_2.0.4

NREL · Dec 4, 2020 · cef3c53 · cef3c53
2 parents ee9c81d + a4987a1
commit cef3c53
Show file tree

Hide file tree

Showing 13 changed files with 2,302 additions and 199 deletions.
diff --git a/docs/TrendAnalysis_example_pvdaq4.ipynb b/docs/TrendAnalysis_example_pvdaq4.ipynb
diff --git a/docs/degradation_and_soiling_example_pvdaq_4.ipynb b/docs/degradation_and_soiling_example_pvdaq_4.ipynb
diff --git a/docs/sphinx/source/TrendAnalysis_example.nblink b/docs/sphinx/source/TrendAnalysis_example.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../TrendAnalysis_example_pvdaq4.ipynb"
+}
diff --git a/docs/sphinx/source/api.rst b/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
 ===========
 

diff --git a/docs/sphinx/source/changelog.rst b/docs/sphinx/source/changelog.rst
@@ -2,9 +2,9 @@ RdTools Change Log
 ==================
 
 .. include:: changelog/v2.0.4.rst
+.. include:: changelog/v2.1.0-beta.0.rst
 .. include:: changelog/v2.0.3.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
-
diff --git a/docs/sphinx/source/changelog/v2.1.0-beta.0.rst b/docs/sphinx/source/changelog/v2.1.0-beta.0.rst
@@ -0,0 +1,33 @@
+*********************************
+v2.1.0-beta.0 (November 20, 2020)
+*********************************
+
+
+Enhancements
+------------
+* Add new :py:mod:`~rdtools.analysis_chains` module to focus on objected-oriented analysis workflows
+  combining other RdTools modules. Includes :py:class:`~rdtools.analysis_chains.TrendAnalysis` class
+  for sensor- and clear-sky-based soiling and degradation analyses (:pull:`117`).
+
+
+Requirements
+------------
+* tables added as a requirement (:pull:`196`).
+
+
+Example Updates
+---------------
+* New example notebook based on PVDAQ system #4 for the new
+  :py:class:`~rdtools.analysis_chains.TrendAnalysis` analysis work flow (:pull:`196` and
+  :pull:`117`).
+* Update ``degradation_and_soiling_example_pvdaq_4.ipynb`` example to match best practice, including 
+  ``pvlib.get_total_irradiance()`` in rdtools.interpolate (:pull:`196` and :pull:`117`).
+* Update ``degradation_and_soiling_example_pvdaq_4.ipynb`` example to use a single
+  ``soiling * ac_power`` signal (:pull:`196`).
+
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Kevin Anderson (:ghuser:`kanderso-nrel`)
+* Chris Deline (:ghuser:`cdeline`)
diff --git a/docs/sphinx/source/index.rst b/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
diff --git a/rdtools/__init__.py b/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