nwm_metrics.event_metric_functions.plot_event_timeseries

nwm_metrics.event_metric_functions.plot_event_timeseries(y_true, y_pred, events_obs, events_sim, start_time=None, end_time=None, threshold=None, threshold_unit='m3/s', plot_filename=None)

Plot observed and simulated streamflow time series with event peak markers.

Parameters:

• y_true – observed streamflow series

• y_pred – simulated streamflow series

• events_obs – observed events with columns “start”, “end”, “peak”, “peak_value”

• events_sim – simulated events with columns “start”, “end”, “peak”, “peak_value”

• start_time – optional start time to subset the series for plotting

• end_time – optional end time to subset the series for plotting

• threshold – optional event threshold to plot as a horizontal line

• plot_filename – optional filename to save the plot

Returns:

None (saves plot to file if plot_filename is provided)