selector.scenario

In this module the scenario object is constructed.

Functions

parse_args()

Argument parser

Classes

Scenario(scenario[, cmd])

Scenario class that stores all relevant information for the configuration
class selector.scenario.LoadOptionsFromFile(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)[source]

Bases: Action

class selector.scenario.Scenario(scenario, cmd={'check_path': False})[source]

Bases: object

Scenario class that stores all relevant information for the configuration

Parameters:

  • scenario (dict or str) – If string, a scenario file will be read in.

  • cmd (dict) – Command line arguments which augment the scenario file/dict.

read_scenario_files(scenario)[source]

Read in the relevant files needed for a complete scenario

Parameters:

scenario (dict) – The scenario dictionary.

Returns:

scenario – The updated scenario dictionary.

Return type:

dict

scenario_from_file(scenario_path)[source]

Read in an ACLib scenario file

Parameters:

scenario_path (str) – Path to the scenario file.

Returns:

Dictionary containing the scenario information.

Return type:

dict

verify_scenario()[source]

Verify that the scenario attributes are valid

selector.scenario.parse_args()[source]

Argument parser

Returns:

Dictionary of parsed arguments.

Return type:

dict