dragonfly_doe2.cli.translate module

dragonfly doe2 translation commands.

dragonfly_doe2.cli.translate.model_to_inp(model_file, full_geometry=False, no_plenum=False, no_ceil_adjacency=False, sim_par_json=None, hvac_mapping='Story', exclude_interior_walls=False, exclude_interior_ceilings=False, equest_version=None, output_file=None, multiplier=True, plenum=True, ceil_adjacency=True, include_interior_walls=True, include_interior_ceilings=True)[source]

Translate a Model file to an INP 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).

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

  • simulation_par – A honeybee-doe2 SimulationPar object to specify how the DOE-2 simulation should be run. If None, default simulation parameters will be generated, which will run the simulation for the full year. (Default: None).

  • hvac_mapping –

    Text to indicate how HVAC systems should be assigned to the exported model. Story will assign one HVAC system for each distinct level polygon, Model will use only one HVAC system for the whole model and AssignedHVAC will follow how the HVAC systems have been assigned to the Rooms.properties.energy.hvac. Choose from the options below. (Default: Story).

    • Room

    • Story

    • Model

    • AssignedHVAC

  • exclude_interior_walls – Boolean to note whether interior wall Faces should be excluded from the resulting string. (Default: False).

  • exclude_interior_ceilings – Boolean to note whether interior ceiling Faces should be excluded from the resulting string. (Default: False).

  • equest_version – An optional text string to denote the version of eQuest for which the INP definition will be generated. If unspecified or unrecognized, the latest version of eQuest will be used.

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