Skip to content

Commit 91c2b05

Browse files
Omesh37cwhanse
andauthored
DOC: clarify hsu soiling ratio minimum value in docstring (#2743)
* DOC: clarify hsu soiling ratio minimum value in docstring * DOC: add PR number to whatsnew * Update pvlib/soiling.py Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * DOC: address review comments - move details to Notes section * DOC: address review comments - move details to Notes section * Update pvlib/soiling.py Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update docs/sphinx/source/whatsnew/v0.15.2.rst Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * DOC: Corrected the indentation * Update pvlib/soiling.py Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> --------- Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
1 parent 200de89 commit 91c2b05

2 files changed

Lines changed: 20 additions & 4 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:`2743`)
2528

2629

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

4346
Contributors
4447
~~~~~~~~~~~~
45-
48+
* :ghuser:`Omesh37`

pvlib/soiling.py

Lines changed: 16 additions & 3 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 HSU model, the soiling ratio has a
23+
minimum of approximately 0.6563. See ``Notes`` for details.
2224
2325
Parameters
2426
----------
@@ -54,6 +56,17 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
5456
soiling_ratio : Series
5557
Values between 0 and 1. Equal to 1 - transmission loss.
5658
59+
Notes
60+
-------
61+
Due to the mathematical form of the HSU model
62+
(``SR = 1 - 0.3437 * erf(0.17 * ω^0.8473)``),
63+
the soiling ratio has a minimum value of approximately 0.6563
64+
(i.e., maximum transmission loss of ~34.37%), regardless of
65+
the accumulated particulate mass. The HSU model is developed
66+
(validated) for accumulated mass densities up to 10 g/m²,
67+
corresponding to a soiling ratio of approximately 0.6875.
68+
See [1]_ for details.
69+
5770
References
5871
-----------
5972
.. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series

0 commit comments

Comments
 (0)