nwm_metrics.metric_functions.kge

nwm_metrics.metric_functions.kge(y_true, y_pred, r_scale=1.0, a_scale=1.0, b_scale=1.0)

Compute Kling-Gupta efficiency between simulation and observation.

Return type:

float

Parameters:

• y_true (pd.Series) – Ground truth or observations

• y_pred (pd.Series) – Modeled values or simulations

• r_scale (float, optional) – correlation scaling factor (default is 1.0)

• a_scale (float, optional) – relative variability scaling factor (default is 1.0)

• b_scale (float, optional) – relative mean scaling factor (default is 1.0)

Returns:

Kling-Gupta efficiency value

Return type:

float

References

Gupta, H. V., Kling, H., Yilmaz, K. K., & Martinez, G. F. (2009). Decomposition of the mean squared error and NSE performance criteria: Implications for improving hydrological modelling. Journal of hydrology, 377(1-2), 80-91.