simulate

honeybee-energy simulate

Commands for simulating Honeybee JSON files in EnergyPlus.

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

idf

Simulate an IDF file in EnergyPlus.

Args:
idf_file: Full path to a simulate-able .idf file.
epw_file: Full path to an .epw file.
honeybee-energy simulate idf [OPTIONS] IDF_FILE EPW_FILE

Options

-f, --folder <folder>

Folder on this computer, into which the result files will be written. If None, the files will be output to the honeybee default simulation folder and placed in a project folder with the same name as the idf_file.

-log, --log-file <log_file>

Optional log file to output the paths of the generated files (idf, sql, zsz, rdd, html, err) if successfully created. By default the list will be printed out to stdout

Default

Arguments

IDF_FILE

Required argument

EPW_FILE

Required argument

model

Simulate a Model in EnergyPlus.

Args:
model_file: Full path to a Model file as either a HBJSON, OSM, or IDF.
epw_file: Full path to an .epw file.
honeybee-energy simulate model [OPTIONS] MODEL_FILE EPW_FILE

Options

-sp, --sim-par-json <sim_par_json>

Full path to a honeybee energy SimulationParameter JSON that describes all of the settings for the simulation. This will be ignored if the input model-file is an OSM or IDF.

-m, --measures <measures>

Full path to a folder containing an OSW JSON be used as the base for the execution of the OpenStudio CLI. While this OSW can contain paths to measures that exist anywhere on the machine, the best practice is to copy the measures into this measures folder and use relative paths within the OSW. This makes it easier to move the inputs for this command from one machine to another.

-as, --additional-string <additional_string>

An additional IDF text string to get appended to the IDF before simulation. The input should include complete EnergyPlus objects as a single string following the IDF format. This input can be used to include small EnergyPlus objects that are not currently supported by honeybee.

-ai, --additional-idf <additional_idf>

An IDF file with text to be appended before simulation. This input can be used to include large EnergyPlus objects that are not currently supported by honeybee.

-r, --report-units <report_units>

A text value to set the units of the OpenStudio Results report that this command can output. Choose from the following: none - no results report will be produced si - all units will be in SI ip - all units will be in IP.

Default

none

-v, --viz-variable <viz_variable>

Text for an EnergyPlus output variable to be visualized on the geometry in an output view_data HTML report. If unspecified, no view_data report is produced. Multiple variables can be requested by using multiple -v options. For example -v “Zone Air System Sensible Heating Rate” -v “Zone Air System Sensible Cooling Rate”

-f, --folder <folder>

Folder on this computer, into which the IDF and result files will be written. If None, the files will be output to the honeybee default simulation folder and placed in a project folder with the same name as the model-file.

--check-model, -bc, --bypass-check

Flag to note whether the Model should be re-serialized to Python and checked before it is translated to .osm. The check is not needed if the model-file was exported directly from the honeybee-energy Python library. It will be automatically bypassed if the model-file is an OSM or IDF.

Default

True

--enforce-rooms, -sr, --skip-no-rooms

Flag to note whether the simulation should be skipped if the Model has no Rooms and is therefore not simulate-able in EnergyPlus. Otherwise, this command will fail with an explicit error about the lack of rooms. Note that the input model must be a HBJSON and you must NOT –bypass-check in order for this to work correctly

Default

True

-log, --log-file <log_file>

Optional log file to output the paths of the generated files (osw, osm, idf, sql, zsz, rdd, html, err) if successfully created. By default the list will be printed out to stdout

Default

Arguments

MODEL_FILE

Required argument

EPW_FILE

Required argument

osm

Simulate an OSM file in EnergyPlus.

Args:
osm_file: Full path to a simulate-able .osm file.
epw_file: Full path to an .epw file.
honeybee-energy simulate osm [OPTIONS] OSM_FILE EPW_FILE

Options

-f, --folder <folder>

Folder on this computer, into which the result files will be written. If None, the files will be output to the honeybee default simulation folder and placed in a project folder with the same name as the idf_file.

-log, --log-file <log_file>

Optional log file to output the paths of the generated files (osw, osm, idf, sql, zsz, rdd, html, err) if successfully created. By default the list will be printed out to stdout

Default

Arguments

OSM_FILE

Required argument

EPW_FILE

Required argument