API Documentation

baseflow.models.lyne_hollick(streamflow_list, alpha)[source]

Calculates baseflow approximations using the Lyne and Hollick equation.

Parameters:

streamflow_list (list) – A list of streamflow values
alpha (float) – Catchment constant between 0 and 1

Returns:

A timeseries list of baseflow values

Return type:

list

Example

import pandas as pd
discharge_time_series = pd.read_csv("/my/sample/file.csv")
alpha = 0.925
baseflow = lyne_hollick(discharge_time_series['Discharge'], alpha)

baseflow.models.chapman(streamflow_list, alpha, beta)[source]

Calculates baseflow approximations using the Chapman equation.

Parameters:

streamflow_list (float series) – A list of streamflow values
alpha (float) – Hydrological recession constant between 0 and 1

Returns:

A timeseries list of baseflow values

Return type:

list

Example

import pandas as pd
discharge_time_series = pd.read_csv("/my/sample/file.csv")
alpha = 0.925
baseflow = chapman(discharge_time_series['Discharge'], alpha)

baseflow.models.eckhardt(streamflow_list, alpha, bfi_max)[source]

Calculates baseflow approximations using the Eckhardt equation.

Parameters:

streamflow_list (float series) – A list of streamflow values
alpha (float) – Hydrological recession constant between 0 and 1
bfi_max – BFImax is the maximum attainable value of the baseflow index, indicating the long-term ratio of baseflow to total streamflow computed using a filtering algorithm. It’s always less than 1, implying the absence of direct runoff in a catchment. This suggests either highly permeable soil or flat terrain.

Returns:

A timeseries list of baseflow values

Return type:

list

Example

import pandas as pd
discharge_time_series = pd.read_csv("/my/sample/file.csv")
alpha = 0.925
bfi_max = 0.8
baseflow = eckhardt(discharge_time_series['Discharge'], alpha, bfi_max)

baseflow.models.chapman_maxwell(streamflow_list, k)[source]

Separates baseflow from a streamflow hydrograph using the Chapman & Maxwell method.

Parameters:

streamflow_list (list) – A list of streamflow values in chronological order.
k (float) – A smoothing parameter between 0 and 1.

Returns:

A timeseries list of baseflow values.

Return type:

list

Example

import pandas as pd
discharge_time_series = pd.read_csv("/my/sample/file.csv")
k = 0.9
baseflow = chapman_maxwell(discharge_time_series['Discharge'], k)

baseflow.models.hyd_run(streamflow_list, k, passes)[source]

Separates baseflow from a streamflow hydrograph using a digital filter method.

Parameters:

streamflow_list (pandas.Series) – A pandas Series of streamflow values in chronological order.
k (float) – A filter coefficient between 0 and 1 (typically 0.9).
passes (int) – Number of times the filter passes through the data (typically 4).

Returns:

A list of baseflow values.

Return type:

list

Example

import pandas as pd
discharge_time_series = pd.read_csv("/my/sample/file.csv")
k = 0.9
passes = 4
baseflow_list = hyd_run(discharge_time_series['Discharge'], k, passes)