honeybee_radiance.cli.multiphase module

honeybee radiance ray-tracing command commands.

honeybee_radiance.cli.multiphase.aperture_group(model_file, octree=None, rflux_sky=None, size=0.2, threshold=0.001, ambient_division=1000, no_room_based=False, orientation=False, vertical_tolerance=None, output_folder=None, output_model=None, room_based=True, view_factor=True)[source]

Automatically calculate aperture groups for exterior apertures.

This function calculates view factor from apertures to sky patches (rfluxmtx). Each aperture is represented by a sensor grid, and the view factor for the whole aperture is the average of the grid. The apertures are grouped based on the threshold.

Parameters:

  • model_file – Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.

  • octree – Path to octree file. The octree will be created from the model file if no file is provided.

  • rflux_sky – Path to rflux sky file. The rflux sky file will be created if no file is provided.

  • size – Aperture grid size. A lower number will give a finer grid and more accurate results but the calculation time will increase. (Default: 0.2).

  • threshold – A number that determines if two apertures/aperture groups can be clustered. A lower number is more accurate but will also increase the number of aperture groups. (Default: 0.001).

  • ambient_division – Number of ambient divisions (-ad) for view factor calculation in rfluxmtx. Increasing the number will give more accurate results but also increase the calculation time. (Default: 1000).

  • no_room_based – Boolean to note whether the apertures should be grouped on a room basis. If grouped on a room basis apertures from different room cannot be in the same group. (Default: False).

  • orientation – Boolean to note whether the apertures should be grouped by calculating view factors for the apertures to a discretized sky or simply by the normal orientation of the apertures. (Default: False).

  • vertical_tolerance – A float value for vertical tolerance between two apertures. If the vertical distance between two apertures is larger than this tolerance the apertures cannot be grouped. If None, the vertical grouping will be skipped. (Default: None).

  • output_folder – Output folder into which the files be written. If None, the files will be written into a folder called aperture_groups within the default simulation folder.

  • output_model – Optional file to output the JSON string of the Model with aperture groups set. If None, the string will simply be returned from this method.