translate

dragonfly-radiance translate

Commands for translating Dragonfly files to/from Radiance.

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

model-to-rad

Translate a Dragonfly Model file to a Radiance string.

The resulting string will include all geometry and all modifiers.

Args:

model_file: Full path to a Dragonfly Model JSON or Pkl file.

dragonfly-radiance translate model-to-rad [OPTIONS] MODEL_FILE

Options

--multiplier, -fg, --full-geometry

Flag to note if the multipliers on each Building story will be passed along to the generated Honeybee Room objects or if full geometry objects should be written for each story in the building.

Default:

True

-p, --plenum, -np, --no-plenum

Flag to indicate whether ceiling/floor plenum depths assigned to Room2Ds should generate distinct 3D Rooms in the translation.

Default:

True

--no-ceil-adjacency, -a, --ceil-adjacency

Flag to indicate whether adjacencies should be solved between interior stories when Room2Ds perfectly match one another in their floor plate. This ensures that Surface boundary conditions are used instead of Adiabatic ones. Note that this input has no effect when the object-per-model is Story.

Default:

True

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

-f, --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 (DFJSON) or a Model

pkl (DFpkl) 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.

dragonfly-radiance translate model-to-rad-folder [OPTIONS] MODEL_FILE

Options

--multiplier, -fg, --full-geometry

Flag to note if the multipliers on each Building story will be passed along to the generated Honeybee Room objects or if full geometry objects should be written for each story in the building.

Default:

True

-p, --plenum, -np, --no-plenum

Flag to indicate whether ceiling/floor plenum depths assigned to Room2Ds should generate distinct 3D Rooms in the translation.

Default:

True

--no-ceil-adjacency, -a, --ceil-adjacency

Flag to indicate whether adjacencies should be solved between interior stories when Room2Ds perfectly match one another in their floor plate. This ensures that Surface boundary conditions are used instead of Adiabatic ones. Note that this input has no effect when the object-per-model is Story.

Default:

True

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

-cg, --create-grids

Flag to note whether sensor grids should be created if none exists. This will only create sensor grids for rooms if there are no sensor grids in the model.

Default:

False

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