translate¶
dragonfly-energy translate¶
Commands for translating Dragonfly JSON files to/from OSM/IDF.
dragonfly-energy translate [OPTIONS] COMMAND [ARGS]...
model-to-gbxml¶
Translate a Model DFJSON to a gbXML file.
dragonfly-energy translate model-to-gbxml [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
- --no-plenum, -p, --plenum¶
Flag to indicate whether ceiling/floor plenums should be auto-generated for the Rooms.
- 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
- -osw, --osw-folder <osw_folder>¶
Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.
- --default-subfaces, -t, --triangulate-subfaces¶
Flag to note whether sub-faces (including Apertures and Doors) should be triangulated if they have more than 4 sides (True) or whether they should be left as they are (False). This triangulation is necessary when exporting directly to EnergyPlus since it cannot accept sub-faces with more than 4 vertices.
- Default
True
- --triangulate-non-planar, -np, --permit-non-planar¶
Flag to note whether any non-planar orphaned geometry in the model should be triangulated upon export. This can be helpful because OpenStudio simply raises an error when it encounters non-planar geometry, which would hinder the ability to save gbXML files that are to be corrected in other software.
- Default
True
- --minimal, -fg, --full-geometry¶
Flag to note whether space boundaries and shell geometry should be included in the exported gbXML vs. just the minimal required non-manifold geometry.
- Default
True
- -ift, --interior-face-type <interior_face_type>¶
Text string for the type to be used for all interior floor faces. If unspecified, the interior types will be left as they are. Choose from: InteriorFloor, Ceiling.
- Default
- -gft, --ground-face-type <ground_face_type>¶
Text string for the type to be used for all ground-contact floor faces. If unspecified, the ground types will be left as they are. Choose from: UndergroundSlab, SlabOnGrade, RaisedFloor.
- Default
- -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-idf¶
Translate a Model JSON file to an IDF using direct-to-idf translators.
The resulting IDF should be simulate-able but not all Model properties might make it into the IDF given that the direct-to-idf translators are used.
dragonfly-energy translate model-to-idf [OPTIONS] MODEL_FILE
Options
- -sp, --sim-par-json <sim_par_json>¶
Full path to a honeybee energy SimulationParameter JSON that describes all of the settings for the simulation. If None default parameters will be generated.
- --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
- --no-plenum, -p, --plenum¶
Flag to indicate whether ceiling/floor plenums should be auto-generated for the Rooms.
- 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
- -a, --additional-str <additional_str>¶
Text string for additional lines that should be added to the IDF.
- Default
- --compact-schedules, -c, --csv-schedules¶
Flag to note whether any ScheduleFixedIntervals in the model should be included in the IDF string as a Schedule:Compact or they should be written as CSV Schedule:File and placed in a directory next to the output-file.
- Default
True
- --hvac-to-ideal-air, -h, --hvac-check¶
Flag to note whether any detailed HVAC system templates should be converted to an equivalent IdealAirSystem upon export. If hvac-check is usedand the Model contains detailed systems, a ValueError will be raised.
- 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 to IDF. Using this flag will affect all Rooms, Faces, Apertures, Doors, and Shades. It will generally result in more read-able names in the IDF but this means that it will not be easy to map the EnergyPlus results back to the original Honeybee Model. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- 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 to IDF. Using this flag will affect all Materials, Constructions, ConstructionSets, Schedules, Loads, and ProgramTypes. It will generally result in more read-able names for the resources in the IDF. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- Default
True
- -f, --output-file <output_file>¶
Optional IDF file to output the IDF string of the translation. By default this will be printed out to stdout
- Default
-
Arguments
- MODEL_FILE¶
Required argument
model-to-osm¶
Translate a Model DFJSON to an OpenStudio Model.
dragonfly-energy translate model-to-osm [OPTIONS] MODEL_FILE
Options
- -sp, --sim-par-json <sim_par_json>¶
Full path to a honeybee energy SimulationParameter JSON that describes all of the settings for the simulation. If None default parameters will be generated.
- -epw, --epw-file <epw_file>¶
Full path to an EPW file to be associated with the exported OSM. This is typically not necessary but may be used when a sim-par-json is specified that requests a HVAC sizing calculation to be run as part of the translation process but no design days are inside this simulation parameter.
- --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
- --no-plenum, -p, --plenum¶
Flag to indicate whether ceiling/floor plenums should be auto-generated for the Rooms.
- 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
- -f, --folder <folder>¶
Folder on this computer, into which the working files, OSM and IDF files will be written. If None, the files will be output in the same location as the model_json.
- -osm, --osm-file <osm_file>¶
Optional file where the OSM will be copied after it is translated in the folder. If None, the file will not be copied.
- -idf, --idf-file <idf_file>¶
Optional file where the IDF will be copied after it is translated in the folder. If None, the file will not be copied.
- --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 to OSM and IDF. Using this flag will affect all Rooms, Faces, Apertures, Doors, and Shades. It will generally result in more read-able names in the OSM and IDF but this means that it will not be easy to map the EnergyPlus results back to the original Honeybee Model. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- 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 to OSM and IDF. Using this flag will affect all Materials, Constructions, ConstructionSets, Schedules, Loads, and ProgramTypes. It will generally result in more read-able names for the resources in the OSM and IDF. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- Default
True
- -log, --log-file <log_file>¶
Optional log file to output the paths to the generated OSM and IDF files if they were successfully created. By default this will be printed out to stdout
- Default
-
Arguments
- MODEL_FILE¶
Required argument
model-to-sdd¶
Translate a Model DFJSON to a CBECC SDD file.
dragonfly-energy translate model-to-sdd [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
- --no-plenum, -p, --plenum¶
Flag to indicate whether ceiling/floor plenums should be auto-generated for the Rooms.
- 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
- -osw, --osw-folder <osw_folder>¶
Folder on this computer, into which the working files will be written. If None, it will be written into the a temp folder in the default simulation folder.
- --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 to SDD. Using this flag will affect all Rooms, Faces, Apertures, Doors, and Shades. It will generally result in more read-able names in the SDD but this means that it will not be easy to map the EnergyPlus results back to the original Honeybee Model. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- 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 to SDD. Using this flag will affect all Materials, Constructions, ConstructionSets, Schedules, Loads, and ProgramTypes. It will generally result in more read-able names for the resources in the SDD. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name.
- Default
True
- -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