`nrel.hive.reporting.handler.stats_handler`

Module Contents

Classes

The StatsHandler compiles various simulation statistics and stores them.

Attributes

nrel.hive.reporting.handler.stats_handler.log[source]

class nrel.hive.reporting.handler.stats_handler.StatsHandler[source]

Bases: nrel.hive.reporting.handler.handler.Handler

The StatsHandler compiles various simulation statistics and stores them.

get_stats(rp: nrel.hive.runner.runner_payload.RunnerPayload) → Dict[source]: special output specifically for the StatsHandler which produces the summary file output :return: the compiled stats for this simulation run

handle(reports: List[nrel.hive.reporting.reporter.Report], runner_payload: nrel.hive.runner.runner_payload.RunnerPayload)[source]

called at each log step.

Parameters:: reports –

:param runner_payload :return:

close(runner_payload: nrel.hive.runner.runner_payload.RunnerPayload)[source]

wrap up anything here. called at the end of the simulation

Returns: