dragonfly_iesve.cli.translate module

honeybee iesve translation commands.

dragonfly_iesve.cli.translate.model_to_gem(model_file, full_geometry=False, no_plenum=False, merge_method='None', output_file=None, multiplier=True, plenum=True)[source]

Translate a Model file to an IES-VE GEM string.

Parameters:

  • model_file – Full path to a Model JSON file (DFJSON) or a Model pkl (DFpkl) file.

  • full_geometry – Boolean 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: False).

  • no_plenum – Boolean to indicate whether ceiling/floor plenum depths assigned to Room2Ds should generate distinct 3D Rooms in the translation. (Default: False).

  • merge_method –

    An optional text string 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. Note that Room2Ds will only be merged if they form a contiguous volume. Otherwise, there will be multiple Rooms per zone or story, each with an integer added at the end of their identifiers. Choose from the following options:

    • None - No merging will occur

    • Zones - Room2Ds in the same zone will be merged

    • PlenumZones - Only plenums in the same zone will be merged

    • Stories - Rooms in the same story will be merged

    • PlenumStories - Only plenums in the same story will be merged

  • output_file – Optional GEM file to output the GEM string of the translation. If None, the string will be returned from this method. (Default: None).