Skip to content

DOC: clarify default depo_veloc values in soiling.hsu Notes #2854

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
weixuan-song wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −0
Open

DOC: clarify default depo_veloc values in soiling.hsu Notes #2854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e31423
DOC: clarify default depo_veloc values in soiling.hsu Notes
weixuan-song Sep 5, 2026
a2120e0
DOC: clarify default depo_veloc values in soiling.hsu Notes
weixuan-song Sep 6, 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.16.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ Enhancements
Documentation
~~~~~~~~~~~~~
* Remove `g_poa_effective` from the :ref:`nomenclature` page (:pull:`2704`)
* Clarify in the ``Notes`` section of :py:func:`pvlib.soiling.hsu` that the
default ``depo_veloc`` values correspond to the settling velocity of
particulates. (:issue:`2535`)


Testing
Expand Down
4 changes: 4 additions & 0 deletions pvlib/soiling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
corresponding to a soiling ratio of approximately 0.6875.
See [1]_ for details.

As recommended by [1]_, the default values of ``depo_veloc``
are the settling velocities of particulates, i.e., only the gravitational
movement of particles.

References
-----------
.. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series
Expand Down