result¶

honeybee-energy result¶

Commands for parsing EnergyPlus results.

honeybee-energy result [OPTIONS] COMMAND [ARGS]...

all-available-info¶

Get a dictionary with metadata of all outputs and run periods within an sql file.

The dictionary will have two keys - ‘run_periods’, ‘outputs’.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result all-available-info [OPTIONS] RESULT_SQL

Options

-f, --output-file <output_file>¶

Optional file to output the list of available outputs. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

available-results¶

Get an array of all timeseries outputs within an sql file.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result available-results [OPTIONS] RESULT_SQL

Options

-f, --output-file <output_file>¶

Optional file to output the list of available outputs. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

available-results-info¶

Get all timeseries outputs within an sql file and metadata about them.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result available-results-info [OPTIONS] RESULT_SQL

Options

-f, --output-file <output_file>¶

Optional file to output the list of available outputs. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

available-run-period-info¶

Get an array of run period info within an sql file.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result available-run-period-info [OPTIONS] RESULT_SQL

Options

-f, --output-file <output_file>¶

Optional file to output the list of available outputs. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

carbon-emission-intensity¶

Get information about energy use intensity and an EUI breakdown by end use.

Args:

result_paths: Path to one or more SQLite files that were generated by

EnergyPlus or folders containing such files. Folders can be from a
single EnergyPlus simulation or may contain multiple SQLite files.
EUI will be computed across all files provided.

honeybee-energy result carbon-emission-intensity [OPTIONS] RESULT_PATHS...

Options

-e, --electricity-emissions <electricity_emissions>¶

A number for the electric grid carbon emissions in kg CO2 per MWh.

Default:: 400

-f, --output-file <output_file>¶

Optional file to output the result of the EUI calculation. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_PATHS¶: Required argument(s)

component-sizes¶

Get a list of ComponentSize JSONs.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result component-sizes [OPTIONS] RESULT_SQL

Options

-ct, --component-type <component_type>¶: A name of a HVAC component type, which will be used to filter the output HVAC components. If “None”, all HVAC component sizes will be output.

-f, --output-file <output_file>¶

Optional file to output the JSON strings of the ComponentSize objects. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

data-by-output¶

Get an array of DataCollection JSONs for a specific EnergyPlus output.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

output_name: The name of an EnergyPlus output to be retrieved from

the SQLite result file. This can also be an array of names if the
string is formatted as a JSON array with [] brackets. Note that only
a single array of data collection JSONs will be returned from this
method and, if data collections must be grouped, the data_by_outputs
method should be used.

honeybee-energy result data-by-output [OPTIONS] RESULT_SQL OUTPUT_NAME

Options

-f, --output-file <output_file>¶

Optional file to output the JSON strings of the data collections. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

OUTPUT_NAME¶: Required argument

data-by-outputs¶

Get an array of DataCollection JSONs for a several EnergyPlus outputs.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

output_names: An array of EnergyPlus output names to be retrieved from

the SQLite result file. This can also be a nested array (an array of
output name arrays) if each string is formatted as a JSON array
with [] brackets.

honeybee-energy result data-by-outputs [OPTIONS] RESULT_SQL [OUTPUT_NAMES]...

Options

-f, --output-file <output_file>¶

Optional file to output the JSON strings of the data collections. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

OUTPUT_NAMES¶: Optional argument(s)

energy-use-intensity¶

Get information about energy use intensity and an EUI breakdown by end use.

Args:

result_paths: Path to one or more SQLite files that were generated by

EnergyPlus or folders containing such files. Folders can be from a
single EnergyPlus simulation or may contain multiple SQLite files.
EUI will be computed across all files provided.

honeybee-energy result energy-use-intensity [OPTIONS] RESULT_PATHS...

Options

--intensity, --absolute¶

Flag to note whether the output values are in absolute kWh of energy use instead of energy use intensity in kWh/m2. Using absolute kWh can be useful when the model contains no floor area for which an intensity metric can be computed but there is still energy use to be evaluated.

Default:: True

--si, --ip¶

Flag to note whether the EUI should be in SI (kWh/m2) or IP (kBtu/ft2) units.

Default:: True

-f, --output-file <output_file>¶

Optional file to output the result of the EUI calculation. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_PATHS¶: Required argument(s)

generation-data¶

Get data collections for electricity generation and usage.

Args:

result_paths: Path to one or more SQLite files that were generated by

EnergyPlus or folders containing such files. Folders can be from a
single EnergyPlus simulation or may contain multiple SQLite files.
Generation metrics will be computed across all files provided.

honeybee-energy result generation-data [OPTIONS] RESULT_PATHS...

Options

-f, --output-file <output_file>¶

Optional file to output the result of the EUI calculation. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_PATHS¶: Required argument(s)

generation-summary¶

Get a summary about electricity generation and usage.

Args:

result_paths: Path to one or more SQLite files that were generated by

EnergyPlus or folders containing such files. Folders can be from a
single EnergyPlus simulation or may contain multiple SQLite files.
Generation metrics will be computed across all files provided.

honeybee-energy result generation-summary [OPTIONS] RESULT_PATHS...

Options

-f, --output-file <output_file>¶

Optional file to output the result of the EUI calculation. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_PATHS¶: Required argument(s)

load-balance¶

Get an array of DataCollection JSONs for a complete model’s load balance.

Args:

model_json: Full path to a Model JSON file used for simulation.

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result load-balance [OPTIONS] MODEL_JSON RESULT_SQL

Options

--normalize, -nn, --no-normalize¶

Flag to note whether the data should be normalized by floor area. This flag has no effect if the requested data is not normalizable

Default:: True

--storage, -ns, --no-storage¶

to note whether the storage term should be included in the list.

Default:: True

-f, --output-file <output_file>¶

Optional file to output the JSON strings of the data collections. By default, it will be printed to stdout

Default:: '-'

Arguments

MODEL_JSON¶: Required argument

RESULT_SQL¶: Required argument

output-csv¶

Get CSV for specific EnergyPlus outputs.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

output_names: The name of an EnergyPlus output to be retrieved from

the SQLite result file. This can also be several output names

for which all data collections should be retrieved.

honeybee-energy result output-csv [OPTIONS] RESULT_SQL [OUTPUT_NAMES]...

Options

-f, --output-file <output_file>¶

Optional file path to output the CSV data of the results. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

OUTPUT_NAMES¶: Optional argument(s)

output-csv-queryable¶

Get CSV of outputs resembling a SQLite table that is easily queryable.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

model_json: Full path to a Model JSON that will be matched with the results.

run_period_name: The name of the run period from which the CSV data will

be selected (eg. “BOSTON LOGAN INTL ARPT ANN CLG .4% CONDNS DB=>MWB”).

output_names: The name of an EnergyPlus output to be retrieved from

the SQLite result file. This can also be several output names

for which all data collections should be retrieved.

honeybee-energy result output-csv-queryable [OPTIONS] RESULT_SQL MODEL_JSON
                                            RUN_PERIOD_NAME [OUTPUT_NAMES]...

Options

--si, --ip¶

Flag to note whether the data in the resulting CSV should be in SI or IP units.

Default:: True

--normalize, -nn, --no-normalize¶

Flag to note whether the data in the resulting CSV should be normalized by floor area (in the case of Zone/System data) or surface area (in the case of Surface data). This flag has no effect if the requested data is not normalizable

Default:: True

-f, --folder <folder>¶: Folder on this computer, into which the CSV files will be written. If None, the files will be output in thesame location as the result_sql.

-log, --log-file <log_file>¶

Optional file to output the names of the columns within the CSV. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

MODEL_JSON¶: Required argument

RUN_PERIOD_NAME¶: Required argument

OUTPUT_NAMES¶: Optional argument(s)

tabular-data¶

Get all the data within a table of a Summary Report using the table name.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

table_name: Text string for the name of a table within a summary

report. (eg. ‘General’).

honeybee-energy result tabular-data [OPTIONS] RESULT_SQL TABLE_NAME

Options

-f, --output-file <output_file>¶

Optional file to output the JSON matrix of tabular data. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

TABLE_NAME¶: Required argument

tabular-metadata¶

Get a dictionary with the names of a table’s rows and columns.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

table_name: Text string for the name of a table within a summary

report. (eg. ‘General’).

honeybee-energy result tabular-metadata [OPTIONS] RESULT_SQL TABLE_NAME

Options

-f, --output-file <output_file>¶

Optional file to output the JSON matrix of tabular data. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument

TABLE_NAME¶: Required argument

zone-sizes¶

Get a dictionary with two arrays of ZoneSize JSONs under ‘cooling’ and ‘heating’.

Args:

result_sql: Full path to an SQLite file that was generated by EnergyPlus.

honeybee-energy result zone-sizes [OPTIONS] RESULT_SQL

Options

-f, --output-file <output_file>¶

Optional file to output the JSON strings of the ZoneSize objects. By default, it will be printed to stdout

Default:: '-'

Arguments

RESULT_SQL¶: Required argument