translate

dragonfly translate

Commands for translating Dragonfly JSON files to honeybee.

dragonfly translate [OPTIONS] COMMAND [ARGS]...

merge-models-to-honeybee

Merge multiple Dragonfly and/or Honeybee Models into a single Honeybee Model.

Args:

base_model: Full path to a Dragonfly Model JSON or Pkl file that serves

as the base into which the other model(s) will be merged.

dragonfly translate merge-models-to-honeybee [OPTIONS] BASE_MODEL

Options

-d, --dragonfly-model <dragonfly_model>

Other Dragonfly Model to be merged into the base model.

-h, --honeybee-model <honeybee_model>

Other Honeybee Model to be merged into the base model.

--multiplier, -fg, --full-geometry

Flag to note if the multipliers on each Building story should 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

--default-adjacency, -sa, --solve-adjacency

Flag to indicate whether all boundary conditions of the original models should be left as they are or whether adjacencies should be solved across the final model when everything is merged together. In this case, solving adjacencies will involve merging all coplanar faces across the Dragonfly/Honeybee Models, intersecting coplanar Faces to get matching areas, and setting Surface boundary conditions for all matching coplanar faces.

Default

True

--enforce-adj-check, -bc, --bypass-adj-check

Flag to note whether an exception should be raised if an adjacency between two Room2Ds is invalid or if the check should be bypassed and the invalid Surface boundary condition should be replaced with an Outdoor boundary condition. If bypass is selected, any Walls containing WindowParameters and an illegal boundary condition will also be replaced with an Outdoor boundary condition.

Default

True

--enforce-solid, -pns, --permit-non-solid

Flag to note whether rooms should be translated as solid extrusions whenever translating them with custom roof geometry produces a non-solid result or the non-solid room geometry should be allowed to remain in the result. The latter is useful for understanding why a particular roof geometry has produced a non-solid result.

Default

True

-f, --output-file <output_file>

Optional file to output the Honeybee Model JSON string with solved adjacency. By default it will be printed out to stdout

Arguments

BASE_MODEL

Required argument

model-from-geojson

Create a Dragonfly model from a geojson file with building footprints.

Args:

geojson: Full path to a geoJSON file with building footprints as Polygons

or MultiPolygons.

dragonfly translate model-from-geojson [OPTIONS] GEOJSON

Options

-l, --location <location>

An optional latitude and longitude, formatted as two floats separated by a comma, (eg. “42.3601,-71.0589”), defining the origin of the geojson file. If nothing is passed, the origin is autocalculated as the bottom-left corner of the bounding box of all building footprints in the geojson file.

-p, --point <point>

An optional X and Y coordinate, formatted as two floats separated by a comma, (eg. “200,200”), defining the origin of the geojson file in the space of the dragonfly model. The coordinates of this point are expected to be in the expected units of this Model.

Default

0,0

-wr, --window-ratio <window_ratio>

A number between 0 and 1 (but not equal to 1) for the ratio between aperture area and wall area to be applied to all walls of all buildings. If specified, this will override the window_ratio key in the geojson

--buildings-only, -all, --all-to-buildings

Flag to indicate if all geometries in the geojson file should be considered buildings. If buildings-only, this method will only generate footprints from geometries that are defined as a “Building” in the type field of its corresponding properties.

Default

True

--no-context, -c, --existing-to-context

Flag to indicate whether polygons possessing a building_status of “Existing” under their properties should be imported as ContextShade instead of Building objects.

Default

True

--separate-top-bottom, -ns, --no-separation

Flag to indicate whether top/bottom stories of the buildings should not be separated in order to account for different boundary conditions of the roof and ground floor.

Default

True

-u, --units <units>

Text for the units system in which the model geometry exists. Must be (Meters, Millimeters, Feet, Inches, Centimeters).

Default

Meters

-t, --tolerance <tolerance>

The maximum difference between x, y, and z values at which vertices are considered equivalent.

-f, --output-file <output_file>

Optional file to output the Model JSON string. By default it will be printed out to stdout

Arguments

GEOJSON

Required argument

model-to-honeybee

Translate a Dragonfly Model file into one or more Honeybee Models.

Args:

model_file: Full path to a Dragonfly Model JSON or Pkl file.

dragonfly translate model-to-honeybee [OPTIONS] MODEL_FILE

Options

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

--no-ceil-adjacency, -a, --ceil-adjacency

Flag to indicate whether adjacencies should be solved between interior stories when Room2D floor and ceiling geometries are coplanar. 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

-sd, --shade-dist <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.

--enforce-adj-check, -bc, --bypass-adj-check

Flag to note whether an exception should be raised if an adjacency between two Room2Ds is invalid or if the check should be bypassed and the invalid Surface boundary condition should be replaced with an Outdoor boundary condition. If bypass is selected, any Walls containing WindowParameters and an illegal boundary condition will also be replaced with an Outdoor boundary condition.

Default

True

--enforce-solid, -pns, --permit-non-solid

Flag to note whether rooms should be translated as solid extrusions whenever translating them with custom roof geometry produces a non-solid result or the non-solid room geometry should be allowed to remain in the result. The latter is useful for understanding why a particular roof geometry has produced a non-solid result.

Default

True

-f, --folder <folder>

Folder on this computer, into which the HBJSON 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 JSON array of dictionaries with information about each of the generated HBJSONs, including their file paths. By default the list will be printed out to stdout

Default

-

Arguments

MODEL_FILE

Required argument

model-to-honeybee-file

Translate a Dragonfly Model into a single Honeybee Model.

Args:

model_file: Full path to a Dragonfly Model JSON or Pkl file.

dragonfly translate model-to-honeybee-file [OPTIONS] MODEL_FILE

Options

--multiplier, -fg, --full-geometry

Flag to note if the multipliers on each Building story should 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-ceil-adjacency, -a, --ceil-adjacency

Flag to indicate whether adjacencies should be solved between interior stories when Room2D floor and ceiling geometries are coplanar. This ensures that Surface boundary conditions are used instead of Adiabatic ones.

Default

True

--enforce-adj-check, -bc, --bypass-adj-check

Flag to note whether an exception should be raised if an adjacency between two Room2Ds is invalid or if the check should be bypassed and the invalid Surface boundary condition should be replaced with an Outdoor boundary condition. If bypass is selected, any Walls containing WindowParameters and an illegal boundary condition will also be replaced with an Outdoor boundary condition.

Default

True

--enforce-solid, -pns, --permit-non-solid

Flag to note whether rooms should be translated as solid extrusions whenever translating them with custom roof geometry produces a non-solid result or the non-solid room geometry should be allowed to remain in the result. The latter is useful for understanding why a particular roof geometry has produced a non-solid result.

Default

True

-f, --output-file <output_file>

Optional file to output the Honeybee Model JSON string with solved adjacency. By default it will be printed out to stdout

Arguments

MODEL_FILE

Required argument