From 8e31423b33f95f7c6af15870cb427dcb3b6dbf55 Mon Sep 17 00:00:00 2001 From: weixuan-song Date: Sat, 5 Sep 2026 11:01:15 +0800 Subject: [PATCH 1/2] DOC: clarify default depo_veloc values in soiling.hsu Notes --- docs/sphinx/source/whatsnew/v0.16.0.rst | 3 +++ pvlib/soiling.py | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/docs/sphinx/source/whatsnew/v0.16.0.rst b/docs/sphinx/source/whatsnew/v0.16.0.rst index 78fe64be82..46d9af810e 100644 --- a/docs/sphinx/source/whatsnew/v0.16.0.rst +++ b/docs/sphinx/source/whatsnew/v0.16.0.rst @@ -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 diff --git a/pvlib/soiling.py b/pvlib/soiling.py index b7582dbedf..e3094e6eec 100644 --- a/pvlib/soiling.py +++ b/pvlib/soiling.py @@ -67,6 +67,14 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10, corresponding to a soiling ratio of approximately 0.6875. See [1]_ for details. + The default values of ``depo_veloc`` correspond to the settling + velocity of particulates, i.e., only the gravitational movement of + particles. The model also accepts deposition velocities, which + comprise other types of particle-fluid interaction; however, the + authors of [1]_ found that deposition velocity considerably + overestimates soiling, while settling velocity performed well in + their case study. + References ----------- .. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series From a2120e0936e71779ebf2e3011773b60a04c5db03 Mon Sep 17 00:00:00 2001 From: weixuan-song Date: Sun, 6 Sep 2026 23:16:56 +0800 Subject: [PATCH 2/2] DOC: clarify default depo_veloc values in soiling.hsu Notes --- pvlib/soiling.py | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/pvlib/soiling.py b/pvlib/soiling.py index e3094e6eec..dfcd60529e 100644 --- a/pvlib/soiling.py +++ b/pvlib/soiling.py @@ -67,13 +67,9 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10, corresponding to a soiling ratio of approximately 0.6875. See [1]_ for details. - The default values of ``depo_veloc`` correspond to the settling - velocity of particulates, i.e., only the gravitational movement of - particles. The model also accepts deposition velocities, which - comprise other types of particle-fluid interaction; however, the - authors of [1]_ found that deposition velocity considerably - overestimates soiling, while settling velocity performed well in - their case study. + 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 -----------