translate

honeybee-idaice translate

Commands for translating Honeybee JSON files to IDM files.

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

model-to-idm

Translate a Model JSON file to an IDA-ICE IDM file.

Args:

model_json: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.

honeybee-idaice translate model-to-idm [OPTIONS] MODEL_JSON

Options

-t, --wall-thickness <wall_thickness>

Maximum thickness of the interior walls. This can include the units of the distance (eg. 1.5ft) or, if no units are provided, the value will be assumed to be in meters (the native units of IDA-ICE). This value will be used to generate the IDA-ICE building body, which dictates which Room Faces are exterior vs. interior. This is necessary because IDA-ICE expects the input model to have gaps between the rooms that represent the wall thickness. This value input here must be smaller than the smallest Room that is expected in resulting IDA-ICE model and it should never be greater than 0.5m in order to avoid creating invalid building bodies for IDA-ICE. For models where the walls are touching each other, use a value of 0.

Default:

'0.4m'

-a, --adjacency-distance <adjacency_distance>

Maximum distance between interior Apertures and Doors at which they are considered adjacent. This can include the units of the distance (eg. 1.5ft) or, if no units are provided, the value will be assumed to be in meters (the native units of IDA-ICE). This is used to ensure that only one interior Aperture of an adjacent pair is written into the IDM. This value should typically be around the –wall-thickness and should ideally not be thicker than 0.5m. But it may be undesirable to set this to zero (like some cases of –wall-thickness), particularly when the adjacent interior geometries are not perfectly matching one another.

Default:

'0.4m'

-n, --name <name>

Deprecated option to set the name of the output file.

-f, --folder <folder>

Deprecated option to set the path to target folder.

-o, --output-file <output_file>

Optional IDM file path to output the IDM bytes of the translation. By default this will be printed out to stdout.

Default:

'-'

Arguments

MODEL_JSON

Required argument