translate

honeybee-energy translate

Commands for translating Honeybee JSON files to/from OSM/IDF.

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

constructions-from-idf

Translate a Construction IDF file to a honeybee JSON as an array of constructions.

Args:
construction_idf: Full path to a Construction IDF file. Only the constructions
and materials in this file will be extracted.
honeybee-energy translate constructions-from-idf [OPTIONS] CONSTRUCTION_IDF

Options

-f, --output-file <output_file>

Optional JSON file to output the JSON string of the translation. By default this will be printed out to stdout

Default

Arguments

CONSTRUCTION_IDF

Required argument

constructions-to-idf

Translate a Construction JSON file to an IDF using direct-to-idf translators.

Args:
construction_json: Full path to a Construction JSON file. This file should
either be an array of non-abridged Constructions or a dictionary where
the values are non-abridged Constructions.
honeybee-energy translate constructions-to-idf [OPTIONS] CONSTRUCTION_JSON

Options

-f, --output-file <output_file>

Optional IDF file to output the IDF string of the translation. By default this will be printed out to stdout

Default

Arguments

CONSTRUCTION_JSON

Required argument

model-from-gbxml

Translate a gbXML to a Honeybee Model (HBJSON).

Args:
gbxml_file: Path to a gbXML file.
honeybee-energy translate model-from-gbxml [OPTIONS] GBXML_FILE

Options

-osw, --osw-folder <osw_folder>

Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.

-f, --output-file <output_file>

Optional HBJSON file to output the string of the translation. By default it printed out to stdout

Arguments

GBXML_FILE

Required argument

model-from-idf

Translate an EnergyPlus Model (IDF) to a Honeybee Model (HBJSON).

Args:
idf_file: Path to an EnergyPlus Model (IDF) file.
honeybee-energy translate model-from-idf [OPTIONS] IDF_FILE

Options

-osw, --osw-folder <osw_folder>

Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.

-f, --output-file <output_file>

Optional HBJSON file to output the string of the translation. By default it printed out to stdout

Arguments

IDF_FILE

Required argument

model-from-osm

Translate a OpenStudio Model (OSM) to a Honeybee Model (HBJSON).

Args:
osm_file: Path to a OpenStudio Model (OSM) file.
honeybee-energy translate model-from-osm [OPTIONS] OSM_FILE

Options

-osw, --osw-folder <osw_folder>

Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.

-f, --output-file <output_file>

Optional HBJSON file to output the string of the translation. By default it printed out to stdout

Arguments

OSM_FILE

Required argument

model-occ-schedules

Translate a Model’s occupancy schedules into a JSON of 0/1 values.

Args:
model_file: Full path to a Model JSON or Pkl file.
honeybee-energy translate model-occ-schedules [OPTIONS] MODEL_FILE

Options

-t, --threshold <threshold>

A number between 0 and 1 for the threshold at and above which a schedule value is considered occupied.

Default

0.1

-p, --period <period>

An AnalysisPeriod string to dictate the start and end of the exported occupancy values (eg. “6/21 to 9/21 between 0 and 23 @1”). Note that the timestep of the period will determine the timestep of output values. If unspecified, the values will be annual.

-f, --output-file <output_file>

Optional file to output the JSON of occupancy values. By default this will be printed out to stdout

Default

Arguments

MODEL_FILE

Required argument

model-to-gbxml

Translate a Honeybee Model (HBJSON) to a gbXML file.

Args:
model_json: Full path to a Honeybee Model JSON file (HBJSON).
honeybee-energy translate model-to-gbxml [OPTIONS] MODEL_JSON

Options

-osw, --osw-folder <osw_folder>

Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.

--default-subfaces, -t, --triangulate-subfaces

Flag to note whether sub-faces (including Apertures and Doors) should be triangulated if they have more than 4 sides (True) or whether they should be left as they are (False). This triangulation is necessary when exporting directly to EnergyPlus since it cannot accept sub-faces with more than 4 vertices.

Default

True

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

--minimal, -fg, --full-geometry

Flag to note whether space boundaries and shell geometry should be included in the exported gbXML vs. just the minimal required non-manifold geometry.

Default

True

-f, --output-file <output_file>

Optional gbXML file to output the string of the translation. By default it printed out to stdout

Arguments

MODEL_JSON

Required argument

model-to-idf

Translate a Model JSON file to a simplified IDF using direct-to-idf translators.

Args:
model_json: Full path to a Honeybee Model JSON file (HBJSON).
honeybee-energy translate model-to-idf [OPTIONS] MODEL_JSON

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. If None default parameters will be generated.

-a, --additional-str <additional_str>

Text string for additional lines that should be added to the IDF.

Default

--compact-schedules, -c, --csv-schedules

Flag to note whether any ScheduleFixedIntervals in the model should be included in the IDF string as a Schedule:Compact or they should be written as CSV Schedule:File and placed in a directory next to the output-file.

Default

True

--hvac-to-ideal-air, -h, --hvac-check

Flag to note whether any detailed HVAC system templates should be converted to an equivalent IdealAirSystem upon export. If hvac-check is usedand the Model contains detailed systems, a ValueError will be raised.

Default

True

-f, --output-file <output_file>

Optional IDF file to output the IDF string of the translation. By default this will be printed out to stdout

Default

Arguments

MODEL_JSON

Required argument

model-to-osm

Translate a Model JSON file into an OpenStudio Model and corresponding IDF.

Args:
model_json: Full path to a Honeybee Model JSON file (HBJSON).
honeybee-energy translate model-to-osm [OPTIONS] MODEL_JSON

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. If None default parameters will be generated.

-f, --folder <folder>

Folder on this computer, into which the working files, OSM and IDF files will be written. If None, the files will be output in the same location as the model_json.

-osm, --osm-file <osm_file>

Optional file where the OSM will be copied after it is translated in the folder. If None, the file will not be copied.

-idf, --idf-file <idf_file>

Optional file where the IDF will be copied after it is translated in the folder. If None, the file will not be copied.

--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 to the generated OSM and IDF files if they were successfully created. By default this will be printed out to stdout

Default

Arguments

MODEL_JSON

Required argument

model-transmittance-schedules

Translate a Model’s shade transmittance schedules into a JSON of fractional vals.

Args:
model_file: Full path to a Model JSON or Pkl file.
honeybee-energy translate model-transmittance-schedules [OPTIONS] MODEL_FILE

Options

-p, --period <period>

An AnalysisPeriod string to dictate the start and end of the exported occupancy values (eg. “6/21 to 9/21 between 0 and 23 @1”). Note that the timestep of the period will determine the timestep of output values. If unspecified, the values will be annual.

-f, --output-file <output_file>

Optional file to output the JSON of occupancy values. By default this will be printed out to stdout

Default

Arguments

MODEL_FILE

Required argument

schedules-from-idf

Translate a schedule IDF file to a honeybee JSON as an array of schedules.

Args:
schedule_idf: Full path to a Schedule IDF file. Only the schedules
and schedule type limits in this file will be extracted.
honeybee-energy translate schedules-from-idf [OPTIONS] SCHEDULE_IDF

Options

-f, --output-file <output_file>

Optional JSON file to output the JSON string of the translation. By default this will be printed out to stdout

Default

Arguments

SCHEDULE_IDF

Required argument

schedules-to-idf

Translate a Schedule JSON file to an IDF using direct-to-idf translators.

Args:
schedule_json: Full path to a Schedule JSON file. This file should
either be an array of non-abridged Schedules or a dictionary where
the values are non-abridged Schedules.
honeybee-energy translate schedules-to-idf [OPTIONS] SCHEDULE_JSON

Options

-f, --output-file <output_file>

Optional IDF file to output the IDF string of the translation. By default this will be printed out to stdout

Default

Arguments

SCHEDULE_JSON

Required argument