Honeybee Primer
Ladybug Tools for Grasshopper Documentation
  • Honeybee Primer
  • Components
    • 0 :: Create
      • Deconstruct Model
      • Model
      • Deconstruct Object
      • Intersect Solids
      • Planarize Brep
      • Room
      • Room from Solid
      • Solve Adjacency
      • Face
      • Properties by Guide Surface
      • Add Subface
      • Aperture
      • Apertures by Ratio
      • Door
      • Facade Parameters
      • Skylights by Ratio
      • Add Shade
      • Extruded Border Shades
      • Louver Shades
      • Shade
      • Mirror
      • Move
      • Rotate
      • Scale
      • Recipe Settings
      • Visualize Recipe Execution
      • Add Prefix
      • Apertures by Guide Surface
      • Apertures by Width Height
      • Custom Ground
      • Set Identifier
      • Set Multiplier
      • Set Story
      • Straight Skeleton
    • 1 :: Visualize
      • Visualize All
      • Visualize Normals
      • Visualize Quick
      • Visualize Wireframe
      • Face Attributes
      • Room Attributes
      • Color Face Attributes
      • Color Room Attributes
      • Label Faces
      • Label Rooms
      • Visualize by BC
      • Visualize by Type
      • Check Versions
      • Config
      • Geometry Properties
    • 2 :: Organize
      • Faces by Attribute
      • Rooms by Attribute
      • Rooms by Floor Height
      • Rooms by Orientation
      • Faces by BC
      • Faces by Type
    • 3 :: Serialize
      • Object to String
      • String to Object
      • Dump Objects
      • Load Objects
      • Dump Compressed Objects
      • Load Compressed Objects
      • Dump gbXML
      • Load gbXML OSM IDF
      • Update HBJSON
      • Validate Model
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 0 :: Create

Skylights by Ratio

PreviousFacade ParametersNextAdd Shade

Last updated 3 years ago

-

Add skylight apertures to a Honeybee Face or Room given a ratio of aperture area to face area.

Note that this component will only add Apertures to Faces that are Roofs and have an Outdoors boundary condition.

Inputs

  • hb_objs [Required]

    A list of honeybee Rooms or Faces to which skylight Apertures will be added based on the inputs.

  • ratio [Required]

    A number between 0 and 1 for the ratio between the area of the apertures and the area of the parent face.

  • x_dim

    The x dimension of the grid cells as a number. (Default: 3 meters)

  • y_dim

    The y dimension of the grid cells as a number. Default is None, which will assume the same cell dimension for y as is set for x.

  • operable

    An optional boolean to note whether the generated Apertures can be opened for ventilation. Default: False.

Outputs

  • report

    Reports, errors, warnings, etc.

  • hb_objs

    The input Honeybee Face or Room with skylight Apertures generated from the input parameters.

[source code]