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 JSON file in EnergyPlus.

Args:
model_json: Full path to a Model JSON file.
epw_file: Full path to an .epw file.
honeybee-energy simulate model [OPTIONS] MODEL_JSON 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.

-osw, --base-osw <base_osw>

Full path to an OSW JSON be used as the base for the execution of the OpenStuduo CLI. This can be used to add measures in the workflow.

-as, --additional-string <additional_string>

An additional 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 EnergyPlus objects that are not currently supported by honeybee.

-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_json.

--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-json was expored directly from the honeybee-energy Python library.

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_JSON

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