Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Load any dragonfly object from a dragonfly JSON file
This includes any Model, Building, Story, Room2D, WindowParameter, or ShadingParameter.
It also includes any energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.
df_file [Required]
A file path to a dragonfly JSON from which objects will be loaded back into Grasshopper. The objects in the file must be non-abridged in order to be loaded back correctly.
load [Required]
Set to "True to load the objects from the _df_file.
report
...
df_objs
A list of dragonfly objects that have been re-serialized from the input file.
-
Serialize any dragonfly JSON text string back to a dragonfly object.
This includes any Model, Building, Story, Room2D, WindowParameter, or ShadingParameter.
It also includes any dragonfly energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.
df_str [Required]
A text string that completely describes the dragonfly object.
df_obj
A Dragonfly object serialized from the input string.
Convert a Dragonfly Model into a series of Honeybee Models.
model [Required]
A Dragonfly Model object.
obj_per_model
Text to describe how the input Buildings should be divided across the output Models. Default: 'Building'. Choose from the following options:
use_multiplier
If True, the multipliers on each Building's Stories will be passed along to the generated Honeybee Room objects, indicating the simulation will be run once for each unique room and then results will be multiplied. If False, full geometry objects will be written for each and every story in the building such that all resulting multipliers will be 1. (Default: True).
add_plenum
Boolean to indicate whether ceiling/floor plenums should be auto-generated for the Rooms. The height of ceiling plenums will be autocalculated as the difference between the Room2D ceiling height and Story ceiling height. The height of the floor plenum will be autocalculated as the difference between the Room2D floor height and Story floor height. (Default: False).
ceil_adjacency
Boolean to note 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 obj_per_model is Story. (Default: False).
cap_shades
Boolean to note whether building shade representations should be capped with a top face. Usually, this is not necessary to account for blocked sun and is only needed when it's important to account for reflected sun off of roofs. (Default: False).
shade_dist
An optional number to note the distance beyond which other buildings' shade should not be exported into a given Model. This is helpful for reducing the simulation run time of each Model when other connected buildings are too far away to have a meaningful impact on the results. 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.
run [Required]
Set to "True" to have the Dragonfly Model translated to a series of Honeybee Models.
report
Reports, errors, warnings, etc.
hb_models
Honeybee Model objects derived from the input _models. These Models are ready to be simulated in either an Energy or Radiance simulation or they can be edited further with the Honeybee components.
-
Convert a Dragonfly Model into an URBANopt-compatible geoJSON with linked Honeybee Model JSONs. Honeybee Model JSONs will be referenced using the "detailed_model_filename" key in the geoJSON.
model [Required]
A Dragonfly Model object.
location [Required]
A ladybug Location object possessing longitude and lattiude data used to position geoJSON file on the globe.
point
A Point for where the _location object exists within the space of the Rhino scene. This is used to posistion the geoJSON file on the globe. (Default: Rhino origin (0, 0, 0)).
use_multiplier
If True, the multipliers on each Building's Stories will be passed along to the generated Honeybee Room objects, indicating the simulation will be run once for each unique room and then results will be multiplied. If False, full geometry objects will be written for each and every story in the building such that all resulting multipliers will be 1. Default: True.
add_plenum
Boolean to indicate whether ceiling/floor plenums should be auto-generated for the Rooms. The height of ceiling plenums will be autocalculated as the difference between the Room2D ceiling height and Story ceiling height. The height of the floor plenum will be autocalculated as the difference between the Room2D floor height and Story floor height. (Default: False).
ceil_adjacency
Boolean to note 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. (Default: False).
shade_dist
An optional number to note the distance beyond which other buildings' shade should not be exported into a given Model. This is helpful for reducing the simulation run time of each Model when other connected buildings are too far away to have a meaningful impact on the results. 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.
des_loop
An optional District Energy System (DES) ThermalLoop that's associated with the dragonfly Model.
network
An optional OpenDSS ElectricalNetwork or RNM RoadNetwork that's associated with the input Dragonfly Model and will be written into the geoJSON. An input here is required to perform an OpenDSS or RNM simulation after running URBANopt.
ground_pv
An optional list of REopt GroundMountPV objects representing ground-mounted photovoltaic fields to be included in a REopt simulation after running URBANopt.
folder
Text for the full path to the folder where the geojson will be written along with all of the Honeybee Model JSONs. If None, the honeybee default simulation folder is used.
write [Required]
Set to "True" to have the Dragonfly Model translated to an URBANopt-compatible geoJSON. This input can also be the integer "2", which will only create the geojson file but not create any honeybee Model json files that are linked to it (note that a geojson produced this way is not compatible with URBANopt).
report
Reports, errors, warnings, etc.
geojson
The path to a geoJSON file that contains polygons for all of the Buildings within the dragonfly model along with their properties (floor area, number of stories, etc.). The polygons will also possess detailed_model_filename keys that align with where the Honeybee Model JSONs are written.
net_json
A JSON file containing a representation of the electrical or street network. This can be loaded back to the original object using the "DF Load Objects" component. This will be None if no network_ is connected.
hb_jsons
A list of file paths to honeybee Model JSONS that correspond to the detailed_model_filename keys in the geojson.
hb_models
A list of honeybee Model objects that were generated in process of writing the URBANopt files. These can be visulazed using the components in the Honeybee 1 :: Visualize tab in order to verify that properties have been translated as expected.
-
Create a Dragonfly Model from a Honeybee Model.
hb_models [Required]
A Honeybee Model or list of Honeybee Models to be converted to a Dragonfly Model.
incl_shades
Boolean to note whether orphaned shades should be included as dragonfly ContextShades. (Default: False).
load [Required]
Set to "True to load the objects from the _df_file.
report
...
df_model
A list of dragonfly objects that have been re-serialized from the input file.
-
Get a validation report that contains a summary of all issues with the Model.
This includes checks for basic properties like adjacency as well as geometry checks.
model [Required]
A Dragonfly Model object to be validated. This can also be the file path to a Model DFJSON that will be validated.
validate [Required]
Set to "True" to validate the the Model and get a report of all issues with the model.
report
A report summarizing any issues with the input _model. If anything is invalid about the input model, this component will give a warning and this report will contain information about the specific parts of the model that are invalid. Otherwise, this report will simply say that the input model is valid.
-
Create a Dragonfly Model from a geoJSON file.
geojson [Required]
Text for the full path to a geojson file to be loaded as a Dragonfly Model.
point
An optional Point for where the bottom-left corner of the bounding rectangle around all of the geoJSON building footprints exists within the Rhino scene. (Default: (0, 0), the Rhino origin).
all_to_bldg
Boolean to indicate if all polygon and multi-polygon geometries in the geojson file should be considered Buildings. If False or unspecified, this component will only generate Dragonfly Buildings from geometries that are defined as a 'Building' in the 'type' field of the 'properties' field of each geoJSON feature. Note that this 'type' field is not a universal convention of all geoJSONs. However, all Dragonfly-expored geoJSONs will have it and all URBANopt-compatible geoJSONs will also have it.
other_geo
Boolean to indicate whether geometry that is not identified as a dragonfly Building should be imported. For large geoJSONs, this can potentially increase the component runtime a lot but this geometry may be useful for constructing other important features like context or electical networks.
import [Required]
Set to "True" to import the geoJSON as a Dragonfly Model.
report
Reports, errors, warnings, etc.
model
A Dragonfly Model object derived from the input geoJSON.
other_geo
Other non-building line segment and polygon data contained within the geoJSON. Will be None unless othergeo is set to True.
location
A ladybug Location object possessing longitude and lattiude data used to position geoJSON file on the globe.
point
A Point for where the _location object exists within the space of the Rhino scene. This is can be used to re-position the geoJSON file on the globe when re-exporting the Dragonfly Model to geoJSON.
Serialize any dragonfly object to a JSON text string. You can use "DF String to Object" component to load the objects from the file back.
This includes any Model, Building, Story, Room2D, WindowParameter, or ShadingParameter.
It also includes any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.
df_obj [Required]
A Dragonfly object to be serialized to a string.
df_str
A text string that completely describes the honeybee object. This can be serialized back into a honeybee object using the "HB String to Object" coponent.
Dump any dragonfly object to a JSON file. You can use "DF Load Objects" component to load the objects from the file back into Grasshopper.
This includes any Model, Building, Story, Room2D, WindowParameter, or ShadingParameter.
It also includes any energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.
df_objs [Required]
A list of Dragonfly objects to be written to a file.
name
A name for the file to which the dragonfly objects will be written. (Default: 'unnamed').
folder
An optional directory into which the dragonfly objects will be written. The default is set to the default simulation folder.
indent
An optional positive integer to set the indentation used in the resulting JSON file.
abridged
Set to "True" to serialize the object in its abridged form. Abridged objects cannot be reserialized back to dragonfly objects on their own but they are used throughout dragonfly to minimize file size and unnecessary duplication.
dump [Required]
Set to "True" to save the dragonfly objects to file.
report
Errors, warnings, etc.
df_file
The location of the file where the dragonfly JSON is saved.