simulate¶

dragonfly-energy simulate¶

Commands for simulating Dragonfly JSON files in EnergyPlus.

dragonfly-energy simulate [OPTIONS] COMMAND [ARGS]...

model¶

Simulate a Dragonfly Model JSON file in EnergyPlus.

Args:

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.

dragonfly-energy simulate model [OPTIONS] MODEL_FILE EPW_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.

-o, --obj-per-model <obj_per_model>¶

Text to describe how the input Model should be divided across the output Models. Choose from: District, Building, Story.

Default:: 'Building'

-sd, --shade-dist <shade_dist>¶: An optional number to note the distance beyond which other buildings shade should not be exported into a given Model. 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.

--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, -np, --no-plenum¶

Flag to indicate whether ceiling/floor plenum depths assigned to Room2Ds should generate distinct 3D Rooms in the translation.

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

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

-m, --measures <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.

-c, --cpu-count <cpu_count>¶: Optional integer to specify the number ofprocessors to be used in simulating each model derived from the input model.If unspecified, this will be one less than the total number of processors available on the machine.

-f, --folder <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.

Arguments

MODEL_FILE¶: Required argument

EPW_FILE¶: Required argument

urbanopt¶

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

Args:

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.

dragonfly-energy simulate urbanopt [OPTIONS] FEATURE_FILE SCENARIO_FILE

Options

-log, --log-file <log_file>¶

Optional log file to output the paths to the generated simulation files if they were successfully created. By default this will be printed out to stdout

Default:: '-'

Arguments

FEATURE_FILE¶: Required argument

SCENARIO_FILE¶: Required argument