Skip to content

Commit

Permalink
this function likes to know what you want out of it
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre committed Jul 25, 2024
1 parent ff795cb commit 9daaa7f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions xclim/indices/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -406,10 +406,10 @@ def spell_length_statistics(
... freq="YS",
... )
Here, a day is part of a spell if it is in any seven (7) day period where the minimum temperature is over 35°C. We then
return the annual sum of the spell lengths, so the total number of days in such spells.
Here, a day is part of a spell if it is in any seven (7) day period where the minimum temperature is over 35°C.
We then return the annual sum of the spell lengths, so the total number of days in such spells.
>>> from xclim.core.units import rate2amount
>>> pram = rate2amount(pr)
>>> pram = rate2amount(pr, out_units="mm")
>>> spell_length_statistics(
... pram,
... threshold="20 mm",
Expand All @@ -420,8 +420,8 @@ def spell_length_statistics(
... freq="YS",
... )
Here, a day is part of a spell if it is in any five (5) day period where the total accumulated precipitation reaches or exceeds
20 mm. We then return the length of the longest of such spells.
Here, a day is part of a spell if it is in any five (5) day period where the total accumulated precipitation reaches
or exceeds 20 mm. We then return the length of the longest of such spells.
"""
thresh = convert_units_to(
threshold,
Expand Down

0 comments on commit 9daaa7f

Please sign in to comment.