main

dragonfly-display

dragonfly display commands.

dragonfly-display [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

model-to-vis

Translate a Dragonfly Model file (.dfjson) to a VisualizationSet file (.vsf).

This command can also optionally translate the Dragonfly Model to a .vtkjs file, which can be visualized in the open source Visual ToolKit (VTK) platform.

Args:

model_file: Full path to a Dragonfly Model (DFJSON or DFpkl) file.

dragonfly-display model-to-vis [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

-c, --color-by <color_by>

Text for the property that dictates the colors of the Model geometry. Choose from: type, boundary_condition, none. If none, only a wireframe of the Model will be generated (assuming the –exclude-wireframe option is not used). None is useful when the primary purpose of the visualization is to display results in relation to the Model geometry or display some room_attr or face_attr as an AnalysisGeometry or Text labels.

Default:

'type'

--wireframe, -xw, --exclude-wireframe

Flag to note whether a ContextGeometry dedicated to the Model Wireframe (in DisplayLineSegment3D) should be included in the output VisualizationSet.

Default:

True

--mesh, --faces

Flag to note whether the colored model geometries should be represented with DisplayMesh3D objects instead of DisplayFace3D objects. Meshes can usually be rendered faster and they scale well for large models but all geometry is triangulated (meaning that their wireframe in certain platforms might not appear ideal).

Default:

True

--show-color-by, -hcb, --hide-color-by

Flag to note whether the color-by geometry should be hidden or shown by default. Hiding the color-by geometry is useful when the primary purpose of the visualization is to display grid-data or room/face attributes but it is still desirable to have the option to turn on the geometry.

Default:

True

-r, --room-attr <room_attr>

An optional text string of an attribute that the Model Rooms have, which will be used to construct a visualization of this attribute in the resulting VisualizationSet. Multiple instances of this option can be passed and a separate VisualizationData will be added to the AnalysisGeometry that represents the attribute in the resulting VisualizationSet (or a separate ContextGeometry layer if –text-attr is True). Room attributes input here can have . that separates the nested attributes from one another. For example, properties.energy.program_type.

-f, --face-attr <face_attr>

An optional text string of an attribute that the Model Faces have, which will be used to construct a visualization of this attribute in the resulting VisualizationSet. Multiple instances of this option can be passed and a separate VisualizationData will be added to the AnalysisGeometry that represents the attribute in the resulting VisualizationSet (or a separate ContextGeometry layer if –text-attr is True). Face attributes input here can have . that separates the nested attributes from one another. For example, properties.energy.construction.

--color-attr, --text-attr

Flag to note whether to note whether the input room-attr and face-attr should be expressed as a colored AnalysisGeometry or a ContextGeometry as text labels.

Default:

True

-m, --grid-display-mode <grid_display_mode>

Text that dictates how the ContextGeometry for Model SensorGrids should display in the resulting visualization. The Default option will draw sensor points whenever there is no grid_data_path and will not draw them at all when grid data is provided, assuming the AnalysisGeometry of the grids is sufficient. Choose from: Default, Points, Wireframe, Surface, SurfaceWithEdges, None.

Default:

'Default'

--show-grid, -hg, --hide-grid

Flag to note whether the SensorGrid ContextGeometry should be hidden or shown by default.

Default:

True

-of, --output-format <output_format>

Text for the output format of the resulting VisualizationSet File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note that both vsf and json refer to the the JSON version of the VisualizationSet file and the distinction between the two is only for help in coordinating file extensions (since both .vsf and .json can be acceptable). Also note that ladybug-vtk must be installed in order for the vtkjs or html options to be usable and the html format refers to a web page with the vtkjs file embedded within it.

Default:

'vsf'

--output-file <output_file>

Optional file to output the string of the visualization file contents. By default, it will be printed out to stdout.

Default:

'-'

Arguments

MODEL_FILE

Required argument

model-comparison-to-vis

Translate two Dragonfly Models to be compared to a VisualizationSet.

This command can also optionally translate the Dragonfly Model to a .vtkjs file, which can be visualized in the open source Visual ToolKit (VTK) platform.

Args:

base_model_file: Full path to a Dragonfly Model (DFJSON or HBpkl) file

representing the base model used in the comparison. Typically, this

is the model with more data to be kept.

incoming_model_file: Full path to a Dragonfly Model (DFJSON or HBpkl) file

representing the incoming model used in the comparison. Typically,

this is the model with new data to be evaluated against the base model.

dragonfly-display model-comparison-to-vis [OPTIONS] BASE_MODEL_FILE
                                          INCOMING_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

-bc, --base-color <base_color>

An optional hexadecimal code for the color of the base model.

Default:

'#74eded'

-ic, --incoming-color <incoming_color>

An optional hexadecimal code for the color of the incoming model.

Default:

'#ed7474'

-of, --output-format <output_format>

Text for the output format of the resulting VisualizationSet File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note that both vsf and json refer to the the JSON version of the VisualizationSet file and the distinction between the two is only for help in coordinating file extensions (since both .vsf and .json can be acceptable). Also note that ladybug-vtk must be installed in order for the vtkjs or html options to be usable and the html format refers to a web page with the vtkjs file embedded within it.

Default:

'vsf'

--output-file <output_file>

Optional file to output the he string of the visualization file contents. By default, it will be printed out to stdout

Default:

'-'

Arguments

BASE_MODEL_FILE

Required argument

INCOMING_MODEL_FILE

Required argument