Skip to content

Commit 7194e3c

Browse files
committed
review comments, improve some descriptions
1 parent c11aee4 commit 7194e3c

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

pvlib/snow.py

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ def _time_delta_in_hours(times):
1515

1616
def fully_covered_nrel(snowfall, snow_depth=None, threshold_snowfall=1.):
1717
'''
18-
Calculates the timesteps when the row's slant height is fully covered
19-
by snow.
18+
Calculates the timesteps when modules are fully covered by snow.
2019
2120
Parameters
2221
----------
@@ -26,22 +25,22 @@ def fully_covered_nrel(snowfall, snow_depth=None, threshold_snowfall=1.):
2625
Snow depth on the ground at the beginning of each time period.
2726
Must have the same index as ``snowfall``. [cm]
2827
threshold_snowfall: float, default 1.0
29-
Hourly snowfall above which snow coverage is set to the row's slant
30-
height. [cm/hr]
28+
Hourly snowfall above which the row is fully covered for that hour.
29+
[cm/hr]
3130
3231
Returns
3332
----------
34-
Series
35-
True where the snowfall exceeds the defined threshold to fully cover
36-
the panel.
33+
covered: Series
34+
A Series of boolean, True where the snowfall exceeds the defined
35+
threshold to fully cover the panel.
3736
3837
Notes
3938
-----
4039
Implements the model described in [1]_ with minor improvements in [2]_.
4140
42-
``snow_depth`` is used to set coverage=0 when no snow is present on the
43-
ground. This check is described in [2]_ as needed for systems with
44-
low tilt angle.
41+
``snow_depth`` is used to return `False` (not fully covered) when no snow
42+
is present on the ground. This check is described in [2]_ as needed for
43+
systems with low tilt angle.
4544
4645
References
4746
----------
@@ -73,8 +72,8 @@ def coverage_nrel(snowfall, poa_irradiance, temp_air, surface_tilt,
7372
snow_depth=None, initial_coverage=0, threshold_snowfall=1.,
7473
can_slide_coefficient=-80., slide_amount_coefficient=0.197):
7574
'''
76-
Calculates the fraction of the slant height of a row of modules covered by
77-
snow at every time step.
75+
Calculates the fraction of the slant height of a row of modules that is
76+
covered by snow at every time step.
7877
7978
Implements the model described in [1]_ with minor improvements in [2]_,
8079
with the change that the output is in fraction of the row's slant height
@@ -119,9 +118,9 @@ def coverage_nrel(snowfall, poa_irradiance, temp_air, surface_tilt,
119118
In [1]_, ``can_slide_coefficient`` is termed `m`, and the value of
120119
``slide_amount_coefficient`` is given in tenths of a module's slant height.
121120
122-
``snow_depth`` is used to set coverage=0 when no snow is present on the
123-
ground. This check is described in [2]_ as needed for systems with
124-
low tilt angle.
121+
``snow_depth`` is used to set ``snow_coverage`` to 0 when no snow is
122+
present on the ground. This check is described in [2]_ as needed for
123+
systems with low tilt angle.
125124
126125
References
127126
----------

0 commit comments

Comments
 (0)