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_json: 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_JSON 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'

--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-cap, -c, --cap

Flag to indicate whether context shade buildings should be capped with a top face.

Default:

True

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

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

-f, --folder <folder>

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

-log, --log-file <log_file>

Optional log file to output a dictionary with the paths of the generated files under the following keys: osm, idf, sql. By default the list will be printed out to stdout

Default:

'-'

Arguments

MODEL_JSON

Required argument

EPW_FILE

Required argument