Skip to content

Commit 8e31423

Browse files
committed
DOC: clarify default depo_veloc values in soiling.hsu Notes
1 parent f025155 commit 8e31423

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs/sphinx/source/whatsnew/v0.16.0.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ Enhancements
7575
Documentation
7676
~~~~~~~~~~~~~
7777
* Remove `g_poa_effective` from the :ref:`nomenclature` page (:pull:`2704`)
78+
* Clarify in the ``Notes`` section of :py:func:`pvlib.soiling.hsu` that the
79+
default ``depo_veloc`` values correspond to the settling velocity of
80+
particulates. (:issue:`2535`)
7881

7982

8083
Testing

pvlib/soiling.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
6767
corresponding to a soiling ratio of approximately 0.6875.
6868
See [1]_ for details.
6969
70+
The default values of ``depo_veloc`` correspond to the settling
71+
velocity of particulates, i.e., only the gravitational movement of
72+
particles. The model also accepts deposition velocities, which
73+
comprise other types of particle-fluid interaction; however, the
74+
authors of [1]_ found that deposition velocity considerably
75+
overestimates soiling, while settling velocity performed well in
76+
their case study.
77+
7078
References
7179
-----------
7280
.. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series

0 commit comments

Comments
 (0)