- [source code]

Provides a list of preset values to choose from

- [source code]

Quickly preview any Honeybee geometry object as a wire frame within the Rhino scene, including all sub-faces and assigned shades.

Inputs

• hb_objs [Required]

A Honeybee Model, Room, Face, Shade, Aperture, or Door to be previewed as a wire frame in the Rhino scene.

Outputs

• geo

The Rhino wireframe version of the Honeybee geometry object, which will be visible in the Rhino scene.

-

Get aligned points and vectors to preview the normal direction of any Honeybee geometry object the Rhino scene, including all sub-faces and assigned shades.

Inputs

• hb_objs [Required]

A Honeybee Model, Room, Face, Shade, Aperture, or Door for which points and vectors will be output in the Rhino scene to show the object's orientation.

Outputs

• points

Points that lie at the center of each surface of the connected _hb_objs. These should be connected to the "Anchor" input of a native Grasshopper "Vector Display" component.

• vectors

Normal vectors for each surface of the connected _hb_objs. These should be connected to the "Vector" input of a native Grasshopper "Vector Display" component.

-

Preview any Honeybee geometry object within the Rhino scene, including all sub-faces and assigned shades.

Inputs

• hb_objs [Required]

A Honeybee Model, Room, Face, Shade, Aperture, or Door to be previewed in the Rhino scene.

Outputs

• geo

The Rhino version of the Honeybee geometry object, which will be visible in the Rhino scene.

- [source code]

Quickly preview any Honeybee geometry object within the Rhino scene.

Sub-faces and assigned shades will not be included in the output, allowing for a faster preview of large lists of objects but without the ability to check the assignment of child objects.

Inputs

• hb_objs [Required]

A Honeybee Model, Room, Face, Shade, Aperture, or Door to be previewed in the Rhino scene.

Outputs

• geo

The Rhino version of the Honeybee geometry object, which will be visible in the Rhino scene.

-

Provides a list of preset values to choose from

- [source code]

Lablel Honeybee faces and sub-faces with their attributes in the Rhino scene.

This can be used as a means to check that correct properties are assigned to different faces and sub-faces.

Inputs

• hb_objs [Required]

  Honeybee Faces, Rooms or a Model to be labeled with their attributes in the Rhino scene.

• attribute

  Text for the name of the attribute with which the faces or sub-faces should be labeled. The Honeybee "Face Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the face and sub-face attributes of that extension. Default: "name".

• sub_faces

  Set to "True" to have the component label the window surfaces in the model instead of the opaque surfaces. By default, this is set to "False" to label just the opaque surfaces.

• txt_height

  An optional number for the height of the text in the Rhino scene. The default is auto-calculated based on the dimensions of the input geometry.

• font

  An optional name of a font in which the labels will display. This must be a font that is installed on this machine in order to work correctly. Default: "Arial".

Outputs

• label_text

  The text with which each of the faces or sub-faces are labeled.

• base_pts

  The base point for each of the text labels.

• labels

  The text objects that are displaying within the Rhino scene.

• wire_frame

  A list of curves representing the outlines of the faces or sub-faces. This is useful for understanding which geometry elements each label corresponds to.

- [source code]

Color Honeybee Faces, Apertures, Doors and Shades in the Rhino scene using their attributes.

This can be used as a means to check that correct properties are assigned to different faces.

Inputs

• hb_objs [Required]

An array of honeybee Rooms, Faces, Apertures, Doors or Shades to be colored with their attributes in the Rhino scene. This can also be an entire Model to be colored.

• attribute [Required]

Text for the name of the attribute with which the faces or sub-faces should be labeled. The Honeybee "Face Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the face and sub-face attributes of that extension.

• legend_par

An optional LegendParameter object to change the display of the colored faces and sub-faces (Default: None).

Outputs

• mesh

Meshes of the faces and sub-faces colored according to their attributes.

• legend

Geometry representing the legend for colored meshes.

• wire_frame

A list of lines representing the outlines of the _hb_objs.

• values

A list of values noting the attribute assigned to each face/sub-face.

• colors

A list of colors noting the color of each face/sub-face in the Rhino scene. This can be used in conjunction with the native Grasshopper "Custom Preview" component to create custom visualizations in the Rhino scene.

• vis_set

An object containing VisualizationSet arguments for drawing a detailed version of the ColorRoom in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the visualization in Rhino.

- [source code]

Visualize room geometry in the Rhino scene organized by boundary condition.

Inputs

• hb_objs [Required]

A Honeybee Model, Room, Face, Aperture, Door or Shade to be previewed in the Rhino scene based on boundary condition.

Outputs

• outdoors

Rhino geometry for the objects with an Outdoors boundary condition.

• surface

Rhino geometry for the objects with a Surface (interior) boundary condition.

• ground

Rhino geometry for the objects with a Ground boundary condition.

• adiabatic

Rhino geometry for the objects with an adiabatic (no heat flow) boundary condition.

• other

Rhino geometry for all objects with a boundary condition other than the four above. All shade geometry will also be added to this list.

• wire_frame

A list of lines representing the outlines of the rooms.

- [source code]

Visualize room geometry in the Rhino scene organized by object and face type.

Inputs

• hb_objs [Required]

  A Honeybee Model, Room, Face, Aperture, Door or Shade to be previewed in the Rhino scene based on type.

Outputs

• walls

  Rhino geometry for the Walls with an Outdoors or Ground boundary condition.

• interior_walls

  Rhino geometry for the Walls with a Surface or Adiabatic boundary condition.

• roofs

  Rhino geometry for the RoofCeilings with an Outdoors or Ground boundary condition.

• ceilings

  Rhino geometry for the RoofCeilings with a Surface or Adiabatic boundary condition.

• exterior_floors

  Rhino geometry for the Floors with an Outdoors or Ground boundary condition.

• interior_floors

  Rhino geometry for the Floors with a Surface or Adiabatic boundary condition.

• air_walls

  Rhino geometry for the AirWalls.

• apertures

  Rhino geometry for the Apertures with an Outdoors boundary condition.

• interior_apertures

  Rhino geometry for the Apertures with a Surface boundary condition.

• doors

  Rhino geometry for the Doors with an Outdoors boundary condition.

• interior_doors

  Rhino geometry for the Doors with a Surface boundary condition.

• outdoor_shades

  Rhino geometry for the Shades assigned to the outdoors of their parent objects. This also includes all orphaned shades of a model.

• indoor_shades

  Rhino geometry for the Shades assigned to the indoors of their parent objects.

• wire_frame

  A list of lines representing the outlines of the rooms.

- [source code]

Color Honeybee rooms in the Rhino scene using their attributes.

This can be used as a means to check that correct properties are assigned to different Rooms.

Inputs

• rooms_model [Required]

An array of honeybee Rooms or honeybee Models to be colored with their attributes in the Rhino scene.

• attribute [Required]

Text for the name of the Room attribute with which the Rooms should be labeled. The Honeybee "Room Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the Room attributes of that extension.

• legend_par

An optional LegendParameter object to change the display of the colored rooms (Default: None).

Outputs

• mesh

Meshes of the room floors colored according to their attributes.

• legend

Geometry representing the legend for colored meshes.

• wire_frame

A list of lines representing the outlines of the rooms.

• values

A list of values that align with the input _rooms noting the attribute assigned to each room.

• colors

A list of colors that align with the input Rooms, noting the color of each Room in the Rhino scene. This can be used in conjunction with the native Grasshopper "Custom Preview" component and other honeybee visualization components (like "HB Visulaize Quick") to create custom visualizations in the Rhino scene.

• vis_set

An object containing VisualizationSet arguments for drawing a detailed version of the ColorRoom in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the visualization in Rhino.

- [source code]

Lablel Honeybee rooms with their attributes in the Rhino scene.

This can be used as a means to check that correct properties are assigned to different Rooms.

Inputs

• rooms_model [Required]

  An array of honeybee Rooms or honeybee Models to be labeled with their attributes in the Rhinoscene.

• attribute

  Text for the name of the Room attribute with which the Rooms should be labeled. The Honeybee "Room Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the Room attributes of that extension. Default: "name".

• txt_height

  An optional number for the height of the text in the Rhino scene. The default is auto-calculated based on the dimensions of the input geometry.

• font

  An optional name of a font in which the labels will display. This must be a font that is installed on this machine in order to work correctly. Default: "Arial".

Outputs

• label_text

  The text with which each of the rooms are labeled.

• base_pts

  The base planes for each of the text labels.

• labels

  The text objects that are displaying within the Rhino scene.

• wire_frame

  A list of curves representing the outlines of the rooms. This is useful for understanding which geometry elements each label corresponds to.

-

Check the local configuration of the engines and data sets used by the honeybee plugin. This is useful for verifying that everything has been installed correctly and that the engines are configured as expected.

Inputs

Outputs

• python_exe

  The path to the Python executable to be used for Ladybug Tools CLI calls.

• py_lib_install

  The path to where the Ladybug Tools Python packages are installed.

• rad_install

  The path to Radiance installation folder if it exists.

• os_install

  The path to OpenStudio installation folder if it exists.

• ep_install

  The path to EnergyPlus installation folder if it exists.

• hb_os_gem

  The path to the honeybee_openstudio_gem if it exists. This gem contains libraries and measures for translating between Honeybee JSON schema and OpenStudio Model schema (OSM).

• standards

  The path to the library of standards if it exists. This library contains the default Modifiers, ModifierSets, Constructions, ConstructionSets, Schedules, and ProgramTypes. It can be extended by dropping IDF or Honeybee JOSN files into the appropriate sub-folder.

• asset_report

  A report of all the assets that have been loaded from the standards library.

• default_sim

  The path to the default simulation folder (where simulation files are written if not specified by the user.).

-

Check the versions of the engines that are being used by the honeybee plugin. This is useful for verifying that everything has been installed correctly and that the versions of the engines are as expected.

Inputs

Outputs

• lbt_gh

The version of Ladybug Tools for Grasshopper that is installed.

• python

The version of Python used for Ladybug Tools CLI calls.

• radiance

The version of Radiance used by Ladybug Tools (will be None if it is not installed).

• openstudio

The version of OpenStudio used by Ladybug Tools (will be None if it is not installed).

• energyplus

The version of EnergyPlus used by Ladybug Tools (will be None if it is not installed).

-

Get geometry properties of honeybee Rooms or a honeybee Model.

Inputs

• rooms [Required]

A list of honeybee Rooms for which or geometry properties will be output. This can also be an entire honeybee Model.

Outputs

• ext_wall_area

A number for the total area of walls in the honeybee rooms with an Outdoors boundary condition (in Rhino model units).

• ext_win_area

A number for the total area of windows in the honeybee rooms with an Outdoors boundary condition (in Rhino model units).

• volume

A number for the volume of the honeybee rooms (in Rhino model units).

• floor_area

A number for the floor area of the honeybee rooms (in Rhino model units). When a Model is connected, the floor area will exclude plenums and other Rooms with that have a True exclude_floor_area property.

• floor_ep_constr

A number for the floor area of the Room accounting for the thickness of EnergyPlus wall constructions. (in Rhino model units). When a Model is connected, the floor area will exclude plenums and other Rooms with that have a True exclude_floor_area property.