Soiling algorithm updates

.github/workflows/nbval.yaml

@@ -29,7 +29,7 @@ jobs:
     - name: Run notebook and check output
       run: |
         # --sanitize-with:  pre-process text to remove irrelevant differences (e.g. warning filepaths)
-        pytest --nbval --sanitize-with docs/nbval_sanitization_rules.cfg docs/${{ matrix.notebook-file }}
+        pytest --nbval --nbval-sanitize-with docs/nbval_sanitization_rules.cfg docs/${{ matrix.notebook-file }}
     - name: Run notebooks again, save files
       run: |
         pip install nbconvert[webpdf]

docs/sphinx/source/changelog/v2.2.0-beta.2.rst

@@ -20,4 +20,4 @@ Requirements
 Contributors
 ------------
 * Martin Springer (:ghuser:`martin-springer`)
-* Michael Deceglie (:ghuser:`mdeceglie`)
+* Michael Deceglie (:ghuser:`mdeceglie`)

docs/sphinx/source/changelog/v3.0.0-beta.0.rst

@@ -15,14 +15,17 @@ when compared with older versions of RdTools
 
 * Upgrade pvlib 0.9.0 to 0.11.0 (:pull:`428`)
 
+* Upgrade soiling algorithms SRR and CODS. Remove experimental warning label. (:pull:`426`)
+
 Enhancements
 ------------
 * Added a new wrapper function for clearsky filters (:pull:`412`)
 * Improve test coverage, especially for the newly added filter capabilities (:pull:`413`)
 * Added codecov.yml configuration file (:pull:`420`)
+* Added new methods perfect_clean_complex and inferred_clean_complex which detects negative shifts and piecewise changes in the slope for soiling detection in :py:func:`~rdtools.soiling.soiling_srr`(:pull:`426`)
 * Availability module no longer considered experimental (:pull:`429`)
 * Add capability to seed the CircularBlockBootstrap (:pull:`429`)
-* Allow sub-daily aggregation in :py:func:`~rdtools.degradation.degradation_year_on_year` (:pull:`390`) 
+* Allow sub-daily aggregation in :py:func:`~rdtools.degradation.degradation_year_on_year` (:pull:`390`)
 
 Bug fixes
 ---------
@@ -31,11 +34,15 @@ Bug fixes
 * Deploy workflow was replaced with trusted publisher workflow for pypi (:pull:`427`)
 * Fix pandas 2.0.0 deprications and update syntax changes (:pull:`428`)
 * Fix numpy 2.0.0 deprications and update syntax changes (:pull:`428`)
+* Fixed pylint bare except error for :py:func:`~rdtools.soiling.segmented_soiling_period`
+in ``soiling.py`` (:pull:`432`)
 
 Tests
 -----
 * Testing matrix was updated to include python = [3.9, 3.10, 3.11, 3.12] (:pull:`428`)
 * nbval sanitization rules were added for date and time stamp (:pull:`428`)
+* Added pytests to cover invalid segementations for
+:py:func:`~rdtools.soiling.segmented_soiling_period` in ``soiling_cods_test.py`` (:pull:`432`)
 
 Documentation
 -------------
@@ -184,5 +191,8 @@ Contributors
 * Martin Springer (:ghuser:`martin-springer`)
 * Michael Deceglie (:ghuser:`mdeceglie`)
 * Kirsten Perry (:ghuser:`kperrynrel`)
+* Matthew Muller (:ghuser:`mmuller`)
+* Noah Moyer (:ghuser:`noromo01`)
+* Quyen Nguyen (:ghuser:`qnguyen345`)
 * Dirk Jordan (:ghuser:`dirkjordan`)
 * Chris Deline (:ghuser:`cdeline`)

rdtools/plotting.py

@@ -4,7 +4,6 @@
 import pandas as pd
 import plotly.express as px
 import numpy as np
-import warnings
 
 
 def degradation_summary_plots(yoy_rd, yoy_ci, yoy_info, normalized_yield,
@@ -133,15 +132,10 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
                              profile_alpha=0.05, ymin=None, ymax=None,
                              profiles=None, point_color=None,
                              profile_color='C1'):
-    '''
+    """
     Create figure to visualize Monte Carlo of soiling profiles used in the SRR
     analysis.
 
-    .. warning::
-        The soiling module is currently experimental. The API, results,
-        and default behaviors may change in future releases (including MINOR
-        and PATCH releases) as the code matures.
-
     Parameters
     ----------
     soiling_info : dict
@@ -168,13 +162,7 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
     Returns
     -------
     fig : matplotlib.figure.Figure
-    '''
-    warnings.warn(
-        'The soiling module is currently experimental. The API, results, '
-        'and default behaviors may change in future releases (including MINOR '
-        'and PATCH releases) as the code matures.'
-    )
-
+    """
     fig, ax = plt.subplots()
     renormalized = normalized_yield / soiling_info['renormalizing_factor']
     ax.plot(renormalized.index, renormalized, 'o', alpha=point_alpha,
@@ -197,14 +185,9 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
 def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,
                           profile_alpha=1, ymin=None, ymax=None,
                           point_color=None, profile_color=None):
-    '''
+    """
     Create figure to visualize valid soiling profiles used in the SRR analysis.
 
-    .. warning::
-        The soiling module is currently experimental. The API, results,
-        and default behaviors may change in future releases (including MINOR
-        and PATCH releases) as the code matures.
-
     Parameters
     ----------
     soiling_info : dict
@@ -228,13 +211,7 @@ def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,
     Returns
     -------
     fig : matplotlib.figure.Figure
-    '''
-    warnings.warn(
-        'The soiling module is currently experimental. The API, results, '
-        'and default behaviors may change in future releases (including MINOR '
-        'and PATCH releases) as the code matures.'
-    )
-
+    """
     sratio = soiling_info['soiling_ratio_perfect_clean']
     fig, ax = plt.subplots()
     renormalized = normalized_yield / soiling_info['renormalizing_factor']
@@ -249,14 +226,9 @@ def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,
 
 
 def soiling_rate_histogram(soiling_info, bins=None):
-    '''
+    """
     Create histogram of soiling rates found in the SRR analysis.
 
-    .. warning::
-        The soiling module is currently experimental. The API, results,
-        and default behaviors may change in future releases (including MINOR
-        and PATCH releases) as the code matures.
-
     Parameters
     ----------
     soiling_info : dict
@@ -268,12 +240,7 @@ def soiling_rate_histogram(soiling_info, bins=None):
     Returns
     -------
     fig : matplotlib.figure.Figure
-    '''
-    warnings.warn(
-        'The soiling module is currently experimental. The API, results, '
-        'and default behaviors may change in future releases (including MINOR '
-        'and PATCH releases) as the code matures.'
-    )
+    """
 
     soiling_summary = soiling_info['soiling_interval_summary']
     fig, ax = plt.subplots()