Merge pull request #214 from NREL/development

2.0.0 Release

Author: mdeceglie

.coveragerc

@@ -1,6 +1,7 @@
 [run]
 omit = 
-    # _version.py doesn't count
+    # _version.py doesn't count, same for _deprecation.py
     rdtools/_version.py
+    rdtools/_deprecation.py
     # omit the test files themselves
     rdtools/test/*

.travis.yml

@@ -7,18 +7,27 @@ python:
   - "3.7"
   - "3.8"
 
-# Test two environments:
-# 1) dependencies with pinned versions from requirements.txt
-# 2) 'pip install --upgrade --upgrade-strategy=eager .' to install upgraded
+# Test three environments:
+# 1) "standard" dependencies with pinned versions from requirements.txt
+# 2) "minimum" dependencies with pinned versions from requirements-min.txt
+#    (only on python 3.6)
+# 3) 'pip install --upgrade --upgrade-strategy=eager .' to install upgraded
 #    dependencies from PyPi using version ranges defined within setup.py
 env:
-  - REQ_ENV='-r requirements.txt .'
-  - REQ_ENV='--upgrade --upgrade-strategy=eager .'
+  - REQ_ENV='-r requirements.txt .[test]'
+  - REQ_ENV='-r requirements-min.txt .[test]'
+  - REQ_ENV='--upgrade --upgrade-strategy=eager .[test]'
 
+
+# PyPI doesn't have wheels built for the minimum requirements (e.g. numpy 1.12)
+# for newer python versions.  Rather than try to get Travis to build them
+# from source, prefer to restrict the minimum-reqs build to only py 3.6:
 jobs:
   exclude:
-  - python: 2.7
-    env: REQ_ENV='--upgrade --upgrade-strategy=eager .'
+  - python: 3.7
+    env: REQ_ENV='-r requirements-min.txt .[test]'
+  - python: 3.8
+    env: REQ_ENV='-r requirements-min.txt .[test]'
 
 install:
   - pip install $REQ_ENV

docs/degradation_and_soiling_example.ipynb

@@ -14,13 +14,13 @@ jedi==0.12.1
 Jinja2==2.10.1
 jsonschema==2.6.0
 jupyter==1.0.0
-jupyter-client==5.2.3
+jupyter-client==6.1.7
 jupyter-console==5.2.0
-jupyter-core==4.4.0
+jupyter-core==4.6.3
 MarkupSafe==1.1.1
 mistune==0.8.3
 nbconvert==5.3.1
-nbformat==4.4.0
+nbformat==5.0.7
 notebook==5.7.8
 pandocfilters==1.4.2
 parso==0.3.1
@@ -29,12 +29,12 @@ pickleshare==0.7.4
 prometheus-client==0.3.0
 prompt-toolkit==1.0.15
 ptyprocess==0.6.0
-Pygments==2.2.0
+Pygments==2.7.1
 pyzmq==17.1.0
 qtconsole==4.3.1
 Send2Trash==1.5.0
 simplegeneric==0.8.1
-tables==3.4.4
+tables==3.6.1
 terminado==0.8.1
 testpath==0.3.1
 tornado==5.1

docs/degradation_and_soiling_example_pvdaq_4.ipynb

@@ -16,6 +16,7 @@ analysis workflow.
 
    degradation
    soiling   
+   availability
    filtering
    normalization
    aggregation
@@ -26,98 +27,119 @@ analysis workflow.
 Degradation
 ===========
 
-Functions for estimating degradation rates from PV system data.
+.. automodule:: rdtools.degradation
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   degradation.degradation_classical_decomposition
-   degradation.degradation_ols
-   degradation.degradation_year_on_year
+   degradation_classical_decomposition
+   degradation_ols
+   degradation_year_on_year
 
 
 Soiling
 =======
 
-Functions for estimating soiling rates from PV system data. 
+.. automodule:: rdtools.soiling
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   soiling.soiling_srr
-   soiling.SRRAnalysis
-   soiling.SRRAnalysis.run
+   soiling_srr
+   monthly_soiling_rates
+   annual_soiling_ratios
+   SRRAnalysis
+   SRRAnalysis.run
+
+
+System Availability
+===================
+
+.. automodule:: rdtools.availability
+   :noindex:
+
+.. autosummary::
+   :toctree: generated/
+   
+   AvailabilityAnalysis
+   AvailabilityAnalysis.run
+   AvailabilityAnalysis.plot
 
 
 Filtering
 =========
 
-Functions to perform filtering on PV system data. 
+.. automodule:: rdtools.filtering
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   filtering.clip_filter
-   filtering.csi_filter
-   filtering.poa_filter
-   filtering.tcell_filter
-   filtering.normalized_filter
+   clip_filter
+   csi_filter
+   poa_filter
+   tcell_filter
+   normalized_filter
 
 
 Normalization
 =============
 
-Functions for normalizing power measurements for further analysis. 
+.. automodule:: rdtools.normalization
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   normalization.check_series_frequency
-   normalization.delta_index
-   normalization.energy_from_power
-   normalization.interpolate
-   normalization.interpolate_series
-   normalization.irradiance_rescale
-   normalization.normalize_with_expected_power
-   normalization.normalize_with_pvwatts
-   normalization.normalize_with_sapm
-   normalization.pvwatts_dc_power
-   normalization.sapm_dc_power
-   normalization.t_step_nanoseconds
-   normalization.trapz_aggregate
+   energy_from_power
+   interpolate
+   irradiance_rescale
+   normalize_with_expected_power
+   normalize_with_pvwatts
+   normalize_with_sapm
+   pvwatts_dc_power
+   sapm_dc_power
+   delta_index
+   check_series_frequency
 
 
 Aggregation
 ===========
 
-Functions to aggregate PV system data. 
+.. automodule:: rdtools.aggregation
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   aggregation.aggregation_insol
+   aggregation_insol
 
 
 Clear-Sky Temperature
 =====================
 
-Functions for modeling ambient temperature. 
+.. automodule:: rdtools.clearsky_temperature
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   clearsky_temperature.get_clearsky_tamb
+   get_clearsky_tamb
 
 
 Plotting
 ========
 
-Functions to visualize degradation and soiling analysis results. 
+.. automodule:: rdtools.plotting
+   :noindex:
 
 .. autosummary::
    :toctree: generated/
 
-   plotting.degradation_summary_plots
-   plotting.soiling_monte_carlo_plot
-   plotting.soiling_interval_plot
-   plotting.soiling_rate_histogram
+   degradation_summary_plots
+   soiling_monte_carlo_plot
+   soiling_interval_plot
+   soiling_rate_histogram
+   availability_summary_plots

docs/notebook_requirements.txt

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

docs/sphinx/source/_images/availability_summary.png

@@ -0,0 +1,126 @@
+
+***********************
+v1.2.3 (April 12, 2020)
+***********************
+
+- Updates dependencies
+- Versioneer bug fix
+- Licence update
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+
+
+*************************
+v1.2.2 (October 12, 2018)
+*************************
+
+Patch that adds author email to enable pypi deployment
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+
+
+*************************
+v1.2.1 (October 12, 2018)
+*************************
+
+This update includes automated testing and deployment to support development
+along with some bug fixes to the library itself, a documented environment for
+the example notebook, and new example results to reflect changes in the example
+dataset. It addresses :issue:`49`, :issue:`76`, :issue:`78`, :issue:`79`,
+:issue:`80`, :issue:`85`, :issue:`86`, and :issue:`92`.
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Adam Shinn (:ghuser:`abshinn`)
+* Chris Deline (:ghuser:`cdeline`)
+* nb137 (:ghuser:`nb137`)
+
+
+***********************
+v1.2.0 (March 30, 2018)
+***********************
+
+This incorporates changes including:
+
+- Enables users to control confidence intervals reported in degradation calculations (:issue:`59`)
+- Adds python 3 support (:issue:`56` and :issue:`67`)
+- Fixes bugs (:issue:`61` :issue:`57`)
+- Improvements/typo fixes to docstrings
+- Fixes error in check for two years of data in degradation_year_on_year
+- Improves the calculations underlying irradiance_rescale
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Ambarish Nag (:ghuser:`ambarishnag`)
+* Gregory Kimball (:ghuser:`GregoryKimball`)
+* Chris Deline (:ghuser:`cdeline`)
+* Mark Mikofski (:ghuser:`mikofski`)
+
+
+*************************
+v1.1.3 (December 6, 2017)
+*************************
+
+This patch includes the following changes:
+
+1. Update the notebook for improved plotting with Pandas v.0.21.0
+2. Fix installation bug related to package data
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Chris Deline (:ghuser:`cdeline`)
+
+
+*************************
+v1.1.2 (November 6, 2017)
+*************************
+
+This patch includes the following changes:
+
+1. Fix bugs in installation
+2. Update requirements
+3. Notebook plots made compatible with pandas v.0.21.0
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+
+
+*************************
+v1.1.1 (November 1, 2017)
+*************************
+
+This patch:
+
+1. Improves documentation
+2. Fixes installation requirements
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Adam Shinn (:ghuser:`abshinn`)
+* Chris Deline (:ghuser:`cdeline`)
+
+
+***************************
+v1.1.0 (September 30, 2017)
+***************************
+
+This update includes the addition of filters, functions to support a clear-sky
+workflow, and updates to the example notebook.
+
+Contributors
+------------
+* Mike Deceglie (:ghuser:`mdeceglie`)
+* Adam Shinn (:ghuser:`abshinn`)
+* Ambarish Nag (:ghuser:`ambarishnag`)
+* Gregory Kimball (:ghuser:`GregoryKimball`)
+* Chris Deline (:ghuser:`cdeline`)
+* Jiyang Yan (:ghuser:`yjy1663`)