translate

honeybee-radiance translate

Commands for translating Honeybee JSON files to/from RAD.

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

model-radiant-enclosure-info

Translate a Model file to a list of JSONs with radiant enclosure information.

There will be one radiant enclosure JSON for each Model SensorGrid written to the output folder and each JSON will contain a list of values about which room (or radiant enclosure) each sensor is located. JSONs will also include a mapper that links the integers of each sensor with the identifier(s) of a room.

Args:
model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
honeybee-radiance translate model-radiant-enclosure-info [OPTIONS] MODEL_FILE

Options

--folder <folder>

Folder into which the radiant enclosure info JSONs will be written. If None, the files will be output in thesame location as the model_file in an enclosure subfolder.

--log-file <log_file>

Optional log file to output the list of generated radiant enclosure JSONs. By default this will be printed to stdout

Arguments

MODEL_FILE

Required argument

model-to-rad

Translate a Model file to a Radiance string.

The resulting strings will include all geometry (Rooms, Faces, Shades, Apertures, Doors) and all modifiers. However, it does not include any states for dynamic geometry and will only write the default state for each dynamic object. To correctly account for dynamic objects, model-to-rad-folder should be used.

Args:
model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
honeybee-radiance translate model-to-rad [OPTIONS] MODEL_FILE

Options

--blk <blk>

Boolean to note whether the “blacked out” version of the geometry should be output, which is useful for direct studies and isolation studies of individual apertures.

Default

False

--minimal, --maximal

Flag to note whether the radiance strings should be written in a minimal format (with spaces instead of line breaks).

Default

False

--output-file <output_file>

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

Default

Arguments

MODEL_FILE

Required argument

model-to-rad-folder

Translate a Model file into a Radiance Folder.

Args:
model_file: Full path to a Model JSON file (HBJSON) or a Model
pkl (HBpkl) file. This can also be a zipped version of a Radiance
folder, in which case this command will simply unzip the file
into the –folder and no other operations will be performed on it.
honeybee-radiance translate model-to-rad-folder [OPTIONS] MODEL_FILE

Options

--folder <folder>

Folder into which the model Radiance folders will be written. If None, the files will be output in the same location as the model_file.

-g, --grid <grid>

List of grids to be included in folder. By default all the sensor grids will be exported. You can also use wildcards here. For instance first_floor_* will select all the sensor grids that has an identifier that starts with first_floor. To filter based on group_identifier use /. For example daylight/* will select all the grids that belong to daylight group.

-v, --view <view>

List of views to be included in folder. By default all the views will be exported. You can also use wildcards to filter multiple views. For instance first_floor_* will select all the views that has an identifier that starts with first_floor. To filter based on group_identifier use /. For example daylight/* will select all the views that belong to daylight group.

--full-match, --no-full-match

Flag to note whether the grids andviews should be filtered by their identifiers as full matches. Setting this to True indicates that wildcard symbols will not be used in the filtering of grids and views.

Default

False

-c, --config-file <config_file>

An optional config file path to modify the default folder names. If None, folder.cfg in honeybee-radiance-folder will be used.

-min, --minimal, -max, --maximal

Flag to note whether the radiance strings should be written in a minimal format (with spaces instead of line breaks).

Default

False

--no-grid-check, -gc, --grid-check

Flag to note whether the model should be checked for the presence of sensor grids. If the check is set and the model has no grids, an explicit error will be raised.

Default

True

--no-view-check, -vc, --view-check

Flag to note whether the model should be checked for the presence of views. If the check is set and the model has no views, an explicit error will be raised.

Default

True

--log-file <log_file>

Optional log file to output the path of the radiance folder generated from the model. By default this will be printed to stdout

Arguments

MODEL_FILE

Required argument

modifiers-from-rad

Translate a Modifier JSON file to a honeybee JSON as an array of modifiers.

Args:
modifier_rad: Full path to a Modifier .rad or .mat file. Only the modifiers

and materials in this file will be extracted.

honeybee-radiance translate modifiers-from-rad [OPTIONS] MODIFIER_RAD

Options

--output-file <output_file>

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

Default

Arguments

MODIFIER_RAD

Required argument

modifiers-to-rad

Translate a Modifier JSON file to an RAD using direct-to-rad translators.

Args:
modifier_json: Full path to a Modifier JSON file. This file should

either be an array of non-abridged Modifiers or a dictionary where the values are non-abridged Modifiers.

honeybee-radiance translate modifiers-to-rad [OPTIONS] MODIFIER_JSON

Options

--minimal, --maximal

Flag to note whether the radiance strings should be written in a minimal format (with spaces instead of line breaks).

Default

False

--output-file <output_file>

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

Default

Arguments

MODIFIER_JSON

Required argument