main

dragonfly-trace

dragonfly trace commands.

dragonfly-trace [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

translate

Commands for translating URBANopt systems to OSM/IDF.

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

model-to-trace700-csv

Translate a Dragonfly Model to a CSV with tables for TRACE 700 attributes.

The resulting CSV tables can be copied into the tables that appear in the Component Tree view of TRACE 700. The order and organization of rooms in the resulting matrix should match that of the gbXML produced from the same model.

Args:

model_file: Full path to a Dragonfly Model file (DFJSON or DFpkl).

dragonfly-trace translate model-to-trace700-csv [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, -sp, --separate-plenum

Flag to indicate whether ceiling/floor plenum depths assigned to Room2Ds should simply be reported as plenum depths in the CSV or they should be used to generate distinct separated plenum rooms in the translation.

Default:

True

-m, --merge-method <merge_method>

Text to describe how the Room2Ds should be merged into individual Rooms during the translation. Specifying a value here can be an effective way to reduce the number of Room volumes in the resulting Model and, ultimately, yield a faster simulation time with less results to manage. Choose from: None, Zones, PlenumZones, Stories, PlenumStories.

Default:

'None'

-ip, --imperial, -si, --metric

Flag to note whether imperial or metric units should be used for values in the output CSV.

Default:

True

--geometry-ids, -gn, --geometry-names

Flag to note whether a cleaned version of all geometry display names should be used instead of identifiers when translating the Model.

Default:

True

--resource-ids, -rn, --resource-names

Flag to note whether a cleaned version of all resource display names should be used instead of identifiers when translating the Model.

Default:

True

-f, --output-file <output_file>

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

Default:

'-'

Arguments

MODEL_FILE

Required argument

model-to-trace700-xlsx

Translate a Dragonfly Model to an Excel file with tables for TRACE 700 attributes.

The resulting Excel tables can be copied into the tables that appear in the Component Tree view of TRACE 700. The order and organization of rooms in the resulting matrix should match that of the gbXML produced from the same model.

Args:

model_file: Full path to a Dragonfly Model file (DFJSON or DFpkl).

dragonfly-trace translate model-to-trace700-xlsx [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, -sp, --separate-plenum

Flag to indicate whether ceiling/floor plenum depths assigned to Room2Ds should simply be reported as plenum depths in the tables or they should be used to generate distinct separated plenum rooms in the translation.

Default:

True

-m, --merge-method <merge_method>

Text to describe how the Room2Ds should be merged into individual Rooms during the translation. Specifying a value here can be an effective way to reduce the number of Room volumes in the resulting Model and, ultimately, yield a faster simulation time with less results to manage. Choose from: None, Zones, PlenumZones, Stories, PlenumStories.

Default:

'None'

-ip, --imperial, -si, --metric

Flag to note whether imperial or metric units should be used for values in the output XLSX.

Default:

True

--geometry-ids, -gn, --geometry-names

Flag to note whether a cleaned version of all geometry display names should be used instead of identifiers when translating the Model.

Default:

True

--resource-ids, -rn, --resource-names

Flag to note whether a cleaned version of all resource display names should be used instead of identifiers when translating the Model.

Default:

True

-f, --output-file <output_file>

Optional XLSX file to output the content of the translation. By default it printed out to stdout.

Default:

'-'

Arguments

MODEL_FILE

Required argument