Skip to content

Commit 7dde893

Browse files
DOC: clarify default depo_veloc values in soiling.hsu Notes (#2854)
* DOC: clarify default depo_veloc values in soiling.hsu Notes * DOC: clarify default depo_veloc values in soiling.hsu Notes --------- Co-authored-by: weixuan-song <weixuan-song@users.noreply.github.com> Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
1 parent 6ada97e commit 7dde893

2 files changed

Lines changed: 7 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
* Correct the transposed table of Hellmann exponents in the
7982
:py:func:`pvlib.atmosphere.windspeed_powerlaw` docstring, which disagreed
8083
with :py:data:`pvlib.atmosphere.HELLMANN_SURFACE_EXPONENTS` in four of its

pvlib/soiling.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ 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+
As recommended by [1]_, the default values of ``depo_veloc``
71+
are the settling velocities of particulates, i.e., only the gravitational
72+
movement of particles.
73+
7074
References
7175
-----------
7276
.. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series

0 commit comments

Comments
 (0)