nrel.hive.app.run

Module Contents

Functions

run_sim(scenario_file[, ...])

runs a single sim and writes outputs

run(→ int)

entry point for a hive application run

_welcome_to_hive()

print_defaults()

Attributes

parser

log

T

nrel.hive.app.run.parser
nrel.hive.app.run.log[source]
nrel.hive.app.run.T
nrel.hive.app.run.run_sim(scenario_file: pathlib.Path | str, custom_instruction_generators: Tuple[T, Ellipsis] | None = None, custom_init_functions: Iterable[nrel.hive.initialization.initialize_simulation.InitFunction] | None = None)[source]

runs a single sim and writes outputs

Parameters:

  • scenario_file – the scenario file to run

  • 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:

0 for success

nrel.hive.app.run.run(custom_instruction_generators: Tuple[T, Ellipsis] | None = None, custom_init_functions: Iterable[nrel.hive.initialization.initialize_simulation.InitFunction] | None = None) → int[source]

entry point for a hive application run :return: 0 if success, 1 if error

nrel.hive.app.run._welcome_to_hive()[source]
nrel.hive.app.run.print_defaults()[source]