Skip to content

Commit

Permalink
tweak docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jarq6c committed Jan 17, 2025
1 parent 48cf72e commit 9ff8c88
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions python/events/src/hydrotools/events/baseflow/eckhardt.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
class ConvergenceError(Exception):
"""Exception raised when iterative numerical process fails
to converge on a solution."""
pass

@dataclass
class BaseflowData:
Expand Down Expand Up @@ -239,11 +238,15 @@ def separate_baseflow(
----------
series: pandas.Series, required
A pandas.Series of streamflow values with a DateTimeIndex. Assumes
first value in series is baseflow.
first and last values in series are baseflow.
output_time_scale: pandas.Timedelta, datetime.timedelta, numpy.timedelta64, str, int, required
Output time-scale (or 'time-step') of the output baseflow time series.
Typically the same time-scale as series.
recession_time_scale: pandas.Timedelta, datetime.timedelta, numpy.timedelta64, str, int, optional, default '1D'
Time-scale or 'time-step' over which to conduct recession analysis.
Generally, it's better to use a recession_time_scale greater than the series time-scale.
The default of '1D' is good for many catchments, but smaller catchments can benefit from a
shorter time-scale of '18h' or '12h'.
recession_window: int, optional, default 5
The minimum number of consecutively decreasing values in series
that indicate a period of recession.
Expand Down

0 comments on commit 9ff8c88

Please sign in to comment.