dragonfly_energy.cli.simulate module

dragonfly energy simulation running commands.

dragonfly_energy.cli.simulate.simulate_model(model_file, epw_file, sim_par_json=None, obj_per_model='Building', shade_dist=None, full_geometry=False, no_plenum=False, ceil_adjacency=False, merge_method='None', measures=None, cpu_count=None, folder=None, multiplier=True, plenum=True, no_ceil_adjacency=True)[source]

Simulate a Dragonfly Model JSON file in EnergyPlus.

Parameters:

  • model_file – Full path to a Dragonfly Model JSON file. This can also be a GeoJSON following the Dragonfly GeoJSON schema.

  • epw_file – Full path to an .epw file.

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

  • obj_per_model –

    Text to describe how the input Buildings should be divided across the output Models. (Default: ‘Building’). Choose from the following options:

    • District - All buildings will be added to a single Honeybee Model.

      Such a Model can take a long time to simulate so this is only recommended for small numbers of buildings or cases where exchange of data between Buildings is necessary.

    • Building - Each building will be exported into its own Model.

      For each Model, the other buildings input to this component will appear as context shade geometry.

    • Story - Each Story of each Building will be exported into its

      own Model. For each Honeybee Model, the other input Buildings will appear as context shade geometry as will all of the other stories of the same building.

  • shade_dist – An optional number to note the distance beyond which other buildings shade should not be exported into a Model. This can include the units of the distance (eg. 100ft) or, if no units are provided, the value will be interpreted in the dragonfly model units. If None, all other buildings will be included as context shade in each and every Model. Set to 0 to exclude all neighboring buildings from the resulting models. (Default: None).

  • 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).

  • 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

  • measures – Full path to a folder containing an OSW JSON be used as the base for the execution of the OpenStudio CLI. While this OSW can contain paths to measures that exist anywhere on the machine, the best practice is to copy the measures into this measures folder and use relative paths within the OSW. This makes it easier to move the inputs for this command from one machine to another.

  • cpu_count – Optional integer to specify the number of processors to be used in simulating each model derived from the input model.

  • folder – Folder on this computer, into which the IDF and result files will be written. If unspecified, the files will be output to the honeybee default simulation folder and placed in a project folder with the same name as the input model.

dragonfly_energy.cli.simulate.simulate_urbanopt(feature_file, scenario_file, log_file=None)[source]

Simulate am URBANopt project folder that is already prepared for simulation.

Parameters:

  • feature_geojson – The full path to a .geojson file containing the footprints of buildings to be simulated.

  • scenario_csv – The full path to a .csv file for the URBANopt scenario.

  • log_file – Optional log file to output the paths to the generated simulation files if they were successfully created. By default this string will be returned from this method.