Skip to content

PerformanceMetrics

PerformanceMetrics

WARNING

This class is currently under development and not recommended for use.

Provides functionality to compute error and efficiency metrics for the SWAT+ model.

Source code in pySWATPlus/performance_metrics.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class PerformanceMetrics:
    '''
    WARNING:
        This class is currently under development and not recommended for use.

    Provides functionality to compute error and efficiency metrics for the SWAT+ model.
    '''

    @property
    def error_options(
        self
    ) -> dict[str, str]:
        '''
        Returns a dictionary of available error options. Keys are the commonly used abbreviations,
        and values are the corresponding full error metric names.
        '''

        error_names = {
            'NSE': 'Nash-Sutcliffe Efficiency',
            'KGE': 'Kling-Gupta Efficiency',
            'MSE': 'Mean Squared Error',
            'RMSE': 'Root Mean Squared Error',
            'PBIAS': 'Percent Bias',
            'MARE': 'Mean Absolute Relative Error'
        }

        return error_names

error_options: dict[str, str] property

Returns a dictionary of available error options. Keys are the commonly used abbreviations, and values are the corresponding full error metric names.