hydrobm.benchmarks.bm_annual_mean_flow

hydrobm.benchmarks.bm_annual_mean_flow(data, cal_mask, streamflow='streamflow')[source]

Calculate the annual mean flow over the calculation period and use that as a predictor for each year in the calculation period.

Parameters:
datapandas DataFrame

Input data containing streamflow column.

cal_maskpandas Series

Boolean mask for the calculation period.

streamflowstr, optional

Name of the streamflow column in the input data. Default is [‘streamflow’].

Returns:
bm_vals: pandas DataSeries

Annual mean flow values for the calculation period.

qbmpandas DataFrame

Benchmark flow time series for the annual mean flow benchmark model.

Notes

This benchmark cannot be used to predict unseen data, because the years don’t repeat. This function will return a benchmark time series that has the same length as the input data, but only the calculation period will have values. The rest will be NaNs.