main

honeybee-display

honeybee display commands.

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

Options

--version

Show the version and exit.

model-to-vis

Translate a Honeybee Model file (.hbjson) to a VisualizationSet file (.vsf).

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

Args:
model_file: Full path to a Honeybee Model (HBJSON or HBpkl) file.
honeybee-display model-to-vis [OPTIONS] MODEL_FILE

Options

-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 room_text_labels 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 face_text_labels 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

--hide-grid, -sg, --show-grid

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

Default

True

-g, --grid-data <grid_data>

An optional path to a folder containing data that aligns with the SensorGrids in the model. Any sub folder within this path that contains a grids_into.json (and associated CSV files) will be converted to an AnalysisGeometry in the resulting VisualizationSet. If a vis_metadata.json file is found within this sub-folder, the information contained within it will be used to customize the AnalysisGeometry. Note that it is acceptable if data and grids_info.json exist in the root of this grid_data_path. Also note that this argument has no impact if honeybee-radiance is not installed and SensorGrids cannot be decoded.

-dm, --grid-data-display-mode <grid_data_display_mode>

Text to set the display_mode of the AnalysisGeometry that is generated from the grid_data_path above. Note that this has no effect if there are no meshes associated with the model SensorGrids. Choose from: Surface, SurfaceWithEdges, Wireframe, Points

Default

Surface

-ad, --active-grid-data <active_grid_data>

Text to specify the active data in the AnalysisGeometry. This should match the name of the sub-folder within the grid_data_path that should be active. If unspecified, the first data set in the grid-data with be active.

-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 JSON string of the config object. By default, it will be printed out to stdout

Default

-

Arguments

MODEL_FILE

Required argument