honeybee_energy.result.generation module

Module to parse on-site electricity generation from EnergyPlus results.

honeybee_energy.result.generation.generation_data_from_sql(sql_results)[source]

Get a data collections of electricity production and consumption.

Parameters:

sql_results – The file path of the SQL result file that has been generated from an energy simulation. This can also be a list of SQL result files in which case electricity generation will be computed across all files. Lastly, it can be a directory or list of directories containing results, in which case, electricity generation will be calculated form all files ending in .sql.

Returns:

A tuple with two values.

  • production – A data collection of the total electricity produced on-site by all generators. Values are in kWh. Will be None if no outputs related to electricity production were requested from the simulation.

  • consumption – A data collection of the total electricity consumed by all end uses. Values are in kWh. Will be None if no outputs related to electricity production were requested from the simulation.

honeybee_energy.result.generation.generation_summary_from_sql(sql_results)[source]

Get a dictionary of electricity generation results from EnergyPlus SQLs.

Parameters:

sql_results – The file path of the SQL result file that has been generated from an energy simulation. This can also be a list of SQL result files in which case electricity generation will be computed across all files. Lastly, it can be a directory or list of directories containing results, in which case, electricity generation will be calculated form all files ending in .sql.

Returns:

A dictionary with several keys.

  • total_production – A positive number for the total electricity produced on-site by all generators. Units are kWh.

  • total_consumption – A negative number for the total electricity consumed on-site by all end uses. Units are kWh.

  • production_used_on_site – A positive number for the total electricity produced on-site that was also consumed on-site. Units are kWh.

  • production_surplus_sold – A positive number for the total electricity produced on-site that was sold to the electric utility as it could not be used on-site. Units are kWh.

  • consumption_purchased – A negative number for the total electricity that was purchased from the electric utility as there was no on-site power at the time to meet the energy consumption demand. Units are kWh.