Skip to content

BUG: fix kimber cleaning threshold and grace period off-by-one #2814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dgowdaan-cmyk wants to merge 3 commits into
base: main
Choose a base branch
from
+844 −812
Open

BUG: fix kimber cleaning threshold and grace period off-by-one #2814

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e12aec
BUG: fix kimber cleaning threshold and grace period off-by-one
dgowdaan-cmyk Jul 7, 2026
4343f19
Fix flake8 E127 continuation line indentation
dgowdaan-cmyk Jul 9, 2026
2af8a00
Add contributor entry
dgowdaan-cmyk Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/sphinx/source/whatsnew/v0.15.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Deprecations

Bug fixes
~~~~~~~~~
* Fixed :py:func:`pvlib.soiling.kimber` so that rainfall equal to
``cleaning_threshold`` triggers cleaning, and fixed an off-by-one
error in the grace period window. (:issue:`2796`)


Enhancements
Expand Down
4 changes: 2 additions & 2 deletions pvlib/soiling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,10 @@ def kimber(rainfall, cleaning_threshold=6, soiling_loss_rate=0.0015,
soiling = pd.Series(soiling, index=rainfall.index, name='soiling')

# rainfall events that clean the panels
rain_events = accumulated_rainfall > cleaning_threshold
rain_events = accumulated_rainfall >= cleaning_threshold

# grace periods windows during which ground is assumed damp, so no soiling
grace_windows = rain_events.rolling(grace_period, closed='right').sum() > 0
grace_windows = rain_events.rolling(grace_period, closed='both').sum() > 0

@cwhanse cwhanse Jul 11, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will not fix the off-by-one issue with grace periods. Grace periods are in days; closed='both' just adds the next timestamp to the grace period. In the case of the tests, it's adding one hour. rolling applies closed to the input data, not the output.

@dgowdaan-cmyk dgowdaan-cmyk Jul 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh yeah I see what you mean now @cwhanse
closed='both' doesn't solve it for daily grace periods.
We would need to shift the result forward by N-1 days instead.

I will take a look and push a fix for this. Thanks for catching it.


# clean panels by subtracting soiling for indices in grace period windows
cleaning = pd.Series(float('NaN'), index=rainfall.index)
Expand Down
Loading
Loading