compare_scenarios() function

Compare the data nodes of several scenarios.

You can specify which data node config identifier should the comparison be performed on.

Parameters:

Name Type Description Default
*scenarios *Scenario

The list of the scenarios to compare.

()
data_node_config_id Optional[str]

The config identifier of the DataNode to perform the comparison on.

If data_node_config_id is not provided, the scenarios are compared on all defined comparators.

None

Returns:

Type Description
Dict[str, Any]

The comparison results. The key is the data node config identifier used for

Dict[str, Any]

comparison.

Raises:

Type Description
InsufficientScenarioToCompare

Raised when only one or no scenario for comparison is provided.

NonExistingComparator

Raised when the scenario comparator does not exist.

DifferentScenarioConfigs

Raised when the provided scenarios do not share the same scenario config.

NonExistingScenarioConfig

Raised when the scenario config of the provided scenarios could not be found.