main

dragonfly-trace

dragonfly trace commands.

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

Options

--version

Show the version and exit.

exp

Commands for translating Honeybee ProgramTypes to TRACE 700 EXP files.

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

program-to-exp

Translate a Honeybee ProgramType file to a TRACE 700 EXP file.

Args:

program_file: Full path to a Honeybee ProgramType JSON file.

dragonfly-trace exp program-to-exp [OPTIONS] PROGRAM_FILE

Options

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

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

Default:

True

-f, --output-file <output_file>

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

Default:

'-'

Arguments

PROGRAM_FILE

Required argument

program-to-trace700-airflow

Translate a Honeybee ProgramType JSON into an Airflow EXP template.

Args:

program_file: Full path to a Honeybee ProgramType JSON file.

dragonfly-trace exp program-to-trace700-airflow [OPTIONS] PROGRAM_FILE

Options

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

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

Default:

True

-f, --output-file <output_file>

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

Default:

'-'

Arguments

PROGRAM_FILE

Required argument

program-to-trace700-internal-loads

Translate a Honeybee ProgramType JSON into an Internal Loads EXP template.

Args:

program_file: Full path to a Honeybee ProgramType JSON file.

dragonfly-trace exp program-to-trace700-internal-loads [OPTIONS] PROGRAM_FILE

Options

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

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

Default:

True

-f, --output-file <output_file>

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

Default:

'-'

Arguments

PROGRAM_FILE

Required argument

program-to-trace700-thermostat

Translate a Honeybee ProgramType JSON into a Thermostat EXP template.

Args:

program_file: Full path to a Honeybee ProgramType JSON file.

dragonfly-trace exp program-to-trace700-thermostat [OPTIONS] PROGRAM_FILE

Options

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

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

Default:

True

-f, --output-file <output_file>

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

Default:

'-'

Arguments

PROGRAM_FILE

Required argument

translate

Commands for translating dragonfly models to/from TRACE.

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

construction-sets-from-exp

Translate all ConstructionTemplates in an TRACE 700 EXP to Honeybee ConstructionSets.

The resulting JSON can be written into a user standards folder to add the constructions to a users standards library.

Args:

exp_file: Path to a TRACE 700 EXP file.

dragonfly-trace translate construction-sets-from-exp [OPTIONS] EXP_FILE

Options

--full, -a, --abridged

Flag to note whether the objects should be translated as an abridged specification instead of a specification that fully describes the object. This option should be used when the constructions-from-exp command will be used to separately translate all of the constructions from the EXP.

Default:

True

-i, --indent <indent>

Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-f, --output-file <output_file>

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

Default:

'-'

Arguments

EXP_FILE

Required argument

constructions-from-exp

Translate all constructions in an EXP file to a honeybee JSON.

Args:

exp_file: Full path to a TRACE 700 EXP file. Only the constructions

and materials in this file will be extracted.

dragonfly-trace translate constructions-from-exp [OPTIONS] EXP_FILE

Options

--full, -a, --abridged

Flag to note whether the objects should be translated as an abridged specification instead of a specification that fully describes the object. This option should be used when the materials-from-exp command will be used to separately translate all of the materials from the EXP.

Default:

True

-i, --indent <indent>

Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-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

EXP_FILE

Required argument

materials-from-exp

Translate all materials in an EXP file to a honeybee JSON.

Args:

exp_file: Full path to a TRACE 700 EXP file. Only the materials in this file

will be extracted.

dragonfly-trace translate materials-from-exp [OPTIONS] EXP_FILE

Options

-i, --indent <indent>

Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-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

EXP_FILE

Required argument

model-to-exp

Translate all resources in a Dragonfly Model file into a single TRACE 700 EXP file.

Args:

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

dragonfly-trace translate model-to-exp [OPTIONS] MODEL_FILE

Options

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

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

Default:

True

-vm, --ventilation-method <ventilation_method>

Text for the ventilation method to be used to calculate outdoor air. Choose from: Sum of Outdoor Air, ASHRAE 62.1

Default:

'Sum of Outdoor Air'

-f, --output-file <output_file>

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

Default:

'-'

Arguments

MODEL_FILE

Required argument

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

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

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

Default:

True

-vm, --ventilation-method <ventilation_method>

Text for the ventilation method to be used to calculate outdoor air. Choose from: Sum of Outdoor Air, ASHRAE 62.1

Default:

'Sum of Outdoor Air'

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

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

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

Translate a Dragonfly Model to a gbXML file.

Args:

model_file: Path to either a DFJSON or DFpkl file. This can also be a

HBJSON or a HBpkl from which a Dragonfly model should be derived.

dragonfly-trace translate model-to-trace700-gbxml [OPTIONS] MODEL_FILE

Options

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

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

Default:

True

-s, --opening-simplification <opening_simplification>

Text string for the type of simplification to perform on windows and doors in the dragonfly model. Choose from: None, MergeAdjWindows, SingleWindow.

Default:

'MergeAdjWindows'

-p, --program-name <program_name>

Optional text to set the name of the software that will appear under the programId and ProductName tags of the DocumentHistory section. This can be set things like “Ladybug Tools” or “Pollination” or some other software in which this gbXML export capability is being run. If None, “OpenStudio” will be used.

-v, --program-version <program_version>

Optional text to set the version of the software that will appear under the DocumentHistory section. If None, and the program_name is also unspecified, only the version of OpenStudio will appear. Otherwise, this will default to “0.0.0” given that the version field is required.

-f, --output-file <output_file>

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

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

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

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

Default:

True

-vm, --ventilation-method <ventilation_method>

Text for the ventilation method to be used to calculate outdoor air. Choose from: Sum of Outdoor Air, ASHRAE 62.1

Default:

'Sum of Outdoor Air'

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

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

-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

model-to-trace700-zip

Translate a Dragonfly Model to a gbXML file.

Args:

model_file: Path to either a DFJSON or DFpkl file. This can also be a

HBJSON or a HBpkl from which a Dragonfly model should be derived.

dragonfly-trace translate model-to-trace700-zip [OPTIONS] MODEL_FILE

Options

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

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

Default:

True

-s, --opening-simplification <opening_simplification>

Text string for the type of simplification to perform on windows and doors in the dragonfly model. Choose from: None, MergeAdjWindows, SingleWindow.

Default:

'MergeAdjWindows'

-vm, --ventilation-method <ventilation_method>

Text for the ventilation method to be used to calculate outdoor air. Choose from: Sum of Outdoor Air, ASHRAE 62.1

Default:

'Sum of Outdoor Air'

-p, --program-name <program_name>

Optional text to set the name of the software that will appear under the programId and ProductName tags of the DocumentHistory section. This can be set things like “Ladybug Tools” or “Pollination” or some other software in which this gbXML export capability is being run. If None, “OpenStudio” will be used.

-v, --program-version <program_version>

Optional text to set the version of the software that will appear under the DocumentHistory section. If None, and the program_name is also unspecified, only the version of OpenStudio will appear. Otherwise, this will default to “0.0.0” given that the version field is required.

-f, --output-file <output_file>

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

Default:

'-'

Arguments

MODEL_FILE

Required argument

programs-from-exp

Translate all ProgramTypes in a TRACE 700 EXP file to a Honeybee JSON.

The resulting JSON can be written into a user standards folder to add the programs to a users standards library.

Args:

exp_file: Path to a TRACE 700 EXP file.

dragonfly-trace translate programs-from-exp [OPTIONS] EXP_FILE

Options

--full, -a, --abridged

Flag to note whether the objects should be translated as an abridged specification instead of a specification that fully describes the object.

Default:

True

-i, --indent <indent>

Optional integer to specify the indentation in the output JSON file. Specifying an value here can produce more read-able JSONs.

-f, --output-file <output_file>

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

Default:

'-'

Arguments

EXP_FILE

Required argument