`nrel.hive.initialization.load`

Module Contents

`load_config`(→ nrel.hive.config.HiveConfig)
`load_simulation`(...)	takes a hive config and attempts to build all assets required to run a scenario

`log`
`T`

nrel.hive.initialization.load.load_config(scenario_file: pathlib.Path | str, output_suffix: str | None = None) → nrel.hive.config.HiveConfig[source]

nrel.hive.initialization.load.load_simulation(config: nrel.hive.config.HiveConfig, custom_instruction_generators: Tuple[T, Ellipsis] | None = None, custom_init_functions: Iterable[nrel.hive.initialization.initialize_simulation.InitFunction] | None = None) → nrel.hive.runner.runner_payload.RunnerPayload[source]

takes a hive config and attempts to build all assets required to run a scenario

Parameters:

config – the hive config
custom_instruction_generators – a set of user defined instruction generators to override the defaults
custom_init_functions – a set of user defined initialization functions to override the defaults

Returns:

the assets required to run a scenario

Raises:

Exception if the scenario_path is not found or if other scenario files are not found or fail to parse