nwm_metrics.metric_functions.nse

nwm_metrics.metric_functions.nse(y_true, y_pred, fun=None, epsilon=[None, 'Pushpalatha2012'], normalized=False, warning_msg=False)

Compute Nash-Sutcliffe efficiency.

Return type:

float

Parameters:

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

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

• fun (str, optional) – Transformation function applied to y_true and y_pred

• epsilon (Union[None, str], optional) – Value added to both y_true and y_pred if fun is logarithm or other functions that are mathematically impossible to compute transformation of zero flows: 1) 0: zero value 2) “Pushpalatha2012”: 1/100 of mean of y_true 3) other numeric value

• normalized (bool, optional) – If True, convert Nash-Sutcliffe efficiency to the normalized value.

Returns:

Nash-Sutcliffe Efficiency value

Return type:

float