honeybee_plus.radiance.sky.skymatrix module

class honeybee_plus.radiance.sky.skymatrix.SkyMatrix(wea, sky_density=1, north=0, hoys=None, mode=0, suffix=None)

Bases: honeybee_plus.radiance.sky._skyBase.RadianceSky

Radiance sky matrix based on an epw weather file.

wea

An instance of ladybug Wea.

sky_density

A positive intger for sky density. [1] Tregenza Sky, [2] Reinhart Sky, etc. (Default: 1)

north

An angle in degrees between 0-360 to indicate north direction (Default: 0).

hoys

The list of hours for generating the sky matrix (Default: 0..8759).

mode

Sky mode 0: total, 1: direct-only, 2: diffuse-only (Default: 0).

suffix

An optional suffix for sky name. The suffix will be added at the end of the standard name. Use this input to customize the new and avoid sky being overwritten by other skymatrix components.

ToString()

Overwrite .NET ToString method.

duplicate()

Duplicate this class.

execute(working_dir, reuse=True)

Generate sky matrix.

Parameters

• working_dir – Folder to execute and write the output.

• reuse – Reuse the matrix if already existed in the folder.

classmethod from_epw_file(epw_file, sky_density=1, north=0, hoys=None, mode=0, suffix=None)

Create sky from an epw file.

classmethod from_json(rec_json)

Create sky from json file { “wea”: {}, // ladybug wea schema “sky_density”: int, // [1] Tregenza Sky, [2] Reinhart Sky, etc. (Default: 1) “north”: float, // Angle in degrees between 0-360 to indicate North “hoys”: [], // List of hours for generating the sky “mode”: int, // Sky mode, integer between 0 and 2 “suffix”: string //Suffix for sky matrix }

hours_match(hours_file)

Check if hours in the hours file matches the hours of wea.

hoys

property isSkyMatrix

Return True.

property is_climate_based

Return True if the sky is generated from values from weather file.

property mode

direct-only, 2: diffuse-only (Default: 0).

Type

Sky mode 0

Type

total, 1

property name

Sky default name.

property north

0).

Type

An angle in degrees between 0-360 to indicate north direction (Default

property sky_density

A positive intger for sky density. [1] Tregenza Sky, [2] Reinhart Sky, etc.

property sky_matrix_parameters

Return sky matrix parameters.

property sky_type

Specify 0 for visible radiation, 1 for total solar radiation.

property sky_type_human_readable

Human readable sky type.

suffix

to_json()

Create json file from sky matrix { “wea”: {}, // ladybug wea schema “sky_density”: int, // [1] Tregenza Sky, [2] Reinhart Sky, etc. (Default: 1) “north”: float, // Angle in degrees between 0-360 to indicate North “hoys”: [], // List of hours for generating the sky “mode”: int, // Sky mode, integer between 0 and 2 “suffix”: string //Suffix for sky matrix }

to_rad_string(working_dir, write_hours=False)

Get the radiance command line as a string.

property wea

An instance of ladybug Wea.

write_wea(target_dir, write_hours=False)

Write the wea file.

WEA carries radiation values from epw and is what gendaymtx uses to generate the sky. :param target_dir: Path to target directory. :param write_hours: Write hours in a separate file in folder.