marEx.ConfigurationError

exception marEx.ConfigurationError(message, details=None, suggestions=None, error_code='CONFIGURATION_ERROR', context=None)[source]

Bases: MarExError

Raise exception for parameter and setup issues.

This exception handles problems with function parameters, configuration settings, and setup requirements that prevent proper operation.

Common scenarios:

  • Invalid parameter values or combinations

  • Missing required configuration

  • Incompatible parameter settings

  • Environment setup issues

Examples

>>> raise ConfigurationError(
...     "Invalid threshold percentile value",
...     details="threshold_percentile must be between 0 and 100",
...     suggestions=["Use percentile value between 50-99 for extreme events",
                      "Common values: 90 (moderate), 95 (strong), 99 (severe)"],
...     context={"provided_value": 150, "valid_range": [0, 100]}
... )

Initialise the Error.

Parameters:
__init__(message, details=None, suggestions=None, error_code='CONFIGURATION_ERROR', context=None)[source]

Initialise the Error.

Parameters: