Skip to content

Commit 0b15c65

Browse files
remove changelog entries from v3.0.0 and added them to pending
1 parent b996d42 commit 0b15c65

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

docs/sphinx/source/changelog/pending.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@ Pending Changes
33
***************
44

55
This document tracks changes pending release for the soiling module refactor.
6-
Changes from :pull:`435` are integrated via :pull:`479`.
6+
Changes from :pull:`426`, :pull:`429`, :pull:`432`, and :pull:`435` are integrated via :pull:`479`.
7+
8+
9+
Breaking Changes
10+
----------------
11+
* Upgrade soiling algorithms SRR and CODS. Remove experimental warning label. (:pull:`426`, :pull:`479`)
712

813

914
API Changes
@@ -17,9 +22,9 @@ API Changes
1722
* Consolidated soiling method names (:pull:`479`):
1823

1924
- Removed ``method="perfect_clean_complex"`` - use ``method="perfect_clean"``
20-
with ``detect_neg_shifts=True`` instead
25+
with ``detect_neg_shifts=True`` and ``piecewise_fit=True`` instead
2126
- Removed ``method="inferred_clean_complex"`` - use ``method="inferred_clean"``
22-
with ``detect_neg_shifts=True`` instead
27+
with ``detect_neg_shifts=True`` and ``piecewise_fit=True`` instead
2328

2429
* Renamed SRR parameters for new features (:pull:`479`):
2530

@@ -32,11 +37,11 @@ Enhancements
3237
* Added negative shift detection capability to :py:func:`~rdtools.soiling.soiling_srr`
3338
via the ``detect_neg_shifts`` parameter. When enabled, detects negative shifts
3439
in soiling profiles that may indicate partial cleaning events or sensor issues.
35-
(:pull:`435`, :pull:`479`)
40+
(:pull:`426`, :pull:`435`, :pull:`479`)
3641

3742
* Added piecewise linear fitting capability to :py:func:`~rdtools.soiling.soiling_srr`
3843
via the ``piecewise_fit`` parameter. Detects changes in soiling rate slope within
39-
intervals using segmented regression. (:pull:`435`, :pull:`479`)
44+
intervals using segmented regression. (:pull:`426`, :pull:`435`, :pull:`479`)
4045

4146
* Added ``collapse_window_days`` parameter to :py:func:`~rdtools.soiling.SRRAnalysis._calc_daily_df`
4247
to control collapsing of consecutive cleaning events (default: 5 days). (:pull:`479`)
@@ -59,10 +64,10 @@ Enhancements
5964
detection consistency. (:pull:`479`)
6065

6166
* Add capability to seed the CircularBlockBootstrap for reproducible uncertainty
62-
calculations. (:pull:`435`)
67+
calculations. (:pull:`429`, :pull:`435`)
6368

6469
* Removed experimental warning label from soiling module. The SRR and CODS
65-
algorithms are now considered stable. (:pull:`435`, :pull:`479`)
70+
algorithms are now considered stable. (:pull:`426`, :pull:`435`, :pull:`479`)
6671

6772

6873
Bug Fixes
@@ -74,6 +79,12 @@ Bug Fixes
7479
where a local variable ``degradation`` shadowed the imported ``degradation``
7580
module, causing ``UnboundLocalError``. Renamed to ``degradation_value``. (:pull:`479`)
7681

82+
* Fixed pandas Copy-on-Write (CoW) compatibility issue in
83+
:py:func:`~rdtools.soiling.SRRAnalysis._calc_result_df` where
84+
``bfill(inplace=True)`` on a chained assignment failed silently with pandas 2.x+.
85+
Changed to assignment-based approach. This was causing incorrect soiling ratio
86+
calculations when ``detect_neg_shifts=True``. (:pull:`479`)
87+
7788

7889
Documentation
7990
-------------

docs/sphinx/source/changelog/v3.0.0.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ when compared with older versions of RdTools
1212
* Turn on the ``two_way_window_filter`` by default in ``TrendAnalysis`` (:pull:`425`)
1313
* Upgrade pvlib 0.9.0 to 0.11.0 (:pull:`428`)
1414

15-
* Upgrade soiling algorithms SRR and CODS. Remove experimental warning label. (:pull:`426`)
1615

1716
Enhancements
1817
------------
@@ -29,13 +28,10 @@ Enhancements
2928
* Added checks to TrendAnalysis for `filter_params` and `filter_params_aggregated`. Raises an error if unkown filter is supplied. (:pull:`436`)
3029
* Added a new wrapper function for clearsky filters (:pull:`412`)
3130
* Added codecov.yml configuration file (:pull:`420`)
32-
* 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`)
3331
* Availability module no longer considered experimental (:pull:`429`)
3432
* Allow sub-daily aggregation in :py:func:`~rdtools.degradation.degradation_year_on_year` (:pull:`390`)
3533
* Circular block bootstrapping added as a method for calculating uncertainty in
3634
``degradation_year_on_year()`` via the ``Uncertainty_method`` argument (:pull:`150`)
37-
* Add capability to seed the CircularBlockBootstrap (:pull:`429`)
38-
3935

4036

4137
Deprecations
@@ -60,11 +56,7 @@ Bug fixes
6056
* Fix flake8 missing whitespaces ``bootstrap_test.py``, ``soiling_cods_test.py`` (:pull:`400`)
6157
* Specify dtype for seasonal samples ``soiling.py`` (:pull:`400`)
6258
* Update deprecated `check_less_precise` to `rtol` ``soiling_cods_test.py`` (:pull:`400`)
63-
* Fixed pylint bare except error for :py:func:`~rdtools.soiling.segmented_soiling_period`
64-
in ``soiling.py`` (:pull:`432`)
6559

66-
* Added pytests to cover invalid segementations for
67-
:py:func:`~rdtools.soiling.segmented_soiling_period` in ``soiling_cods_test.py`` (:pull:`432`)
6860

6961
Requirements
7062
------------
@@ -230,6 +222,3 @@ Contributors
230222
* Kirsten Perry (:ghuser:`kperrynrel`)
231223
* Åsmund Skomedal (:ghuser:`asmunds`)
232224
* Martin Springer (:ghuser:`martin-springer`)
233-
* Matthew Muller (:ghuser:`mmuller`)
234-
* Noah Moyer (:ghuser:`noromo01`)
235-
* Quyen Nguyen (:ghuser:`qnguyen345`)

0 commit comments

Comments
 (0)