Skip to content

Commit d1aecc4

Browse files
committed
DOC: clarify hsu soiling ratio minimum value in docstring
1 parent 200de89 commit d1aecc4

2 files changed

Lines changed: 18 additions & 5 deletions

File tree

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Enhancements
2222

2323
Documentation
2424
~~~~~~~~~~~~~
25+
* Clarified that :py:func:`pvlib.soiling.hsu` has an implicit minimum
26+
soiling ratio of approximately 0.6563 due to the mathematical form
27+
of the model. (:issue:`2534`, :pull:`XXXX`)
2528

2629

2730
Testing
@@ -42,4 +45,4 @@ Maintenance
4245

4346
Contributors
4447
~~~~~~~~~~~~
45-
48+
Omesh37

pvlib/soiling.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
1616
Calculates soiling ratio given particulate and rain data using the
1717
Fixed Velocity model from Humboldt State University (HSU).
1818
19-
The HSU soiling model [1]_ returns the soiling ratio, a value between zero
20-
and one which is equivalent to (1 - transmission loss). Therefore a soiling
21-
ratio of 1.0 is equivalent to zero transmission loss.
19+
The HSU soiling model [1]_ returns the soiling ratio, a value between
20+
zero and one which is equivalent to (1 - transmission loss).
21+
Therefore a soiling ratio of 1.0 is equivalent to zero transmission loss.
22+
Due to the mathematical form of the model, the soiling ratio has an
23+
implicit minimum of approximately 0.6563. See ``Returns`` for details.
2224
2325
Parameters
2426
----------
@@ -49,10 +51,18 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
4951
It is recommended that `rain_accum_period` be between 1 hour and
5052
24 hours.
5153
52-
Returns
54+
Returns
5355
-------
5456
soiling_ratio : Series
5557
Values between 0 and 1. Equal to 1 - transmission loss.
58+
Due to the mathematical form of the model
59+
(``SR = 1 - 0.3437 * erf(0.17 * ω^0.8473)``),
60+
the soiling ratio has an implicit minimum value of approximately
61+
0.6563 (i.e., maximum transmission loss of ~34.37%), regardless
62+
of the accumulated particulate mass. Note that the valid range
63+
of the underlying equation is further limited to accumulated
64+
mass densities up to 10 g/m², corresponding to a soiling ratio
65+
of approximately 0.6875. See [1]_ and [2]_ for details.
5666
5767
References
5868
-----------

0 commit comments

Comments
 (0)