honeybee_radiance.lightsource.sky.skydome module

Virtual skydome for daylight coefficient studies with constant radiance.

class honeybee_radiance.lightsource.sky.skydome.SkyDome(sky_density=1, ground_emittance=0.2)[source]

Bases: honeybee_radiance.lightsource.sky._skybase._SkyDome

Virtual skydome for daylight coefficient studies with constant radiance.

Use this sky to calculate daylight matrix.

#@rfluxmtx h=u u=Y
void glow ground_glow
0
0
4 0.2 0.2 0.2 0

ground_glow source ground
0
0
4 0 0 -1 180

#@rfluxmtx h=r1 u=Y
void glow sky_glow
0
0
4 1 1 1 0

sky_glow source sky
0
0
4 0 0 1 180
Parameters
  • density

    Sky patch subdivision density. This values is similar to -m option in gendaymtx command. Default is 1 which means 145 sky patches and 1 patch for the ground.

    One can add to the resolution typically by factors of two (2, 4, 8, …) which yields a higher resolution sky using the Reinhart patch subdivision For example, setting density to 4 yields a sky with 2305 patches plus one patch for the ground.

  • ground_emittance – Ground emittance value between 0.0 and 1.0 - Default: 0.2

ToString()

Overwrite .NET ToString.

classmethod from_dict(data)

Create the sky baseclass from a dictionary.

Parameters

data – A python dictionary in the following format

{
    'type': 'SkyDome',
    'ground_hemisphere': {},  # see ground.Ground class [optional],
    'sky_hemisphere': {}  # see hemisphere.Hemisphere class [optional]
}
to_dict()

Translate sky to a dictionary.

to_file(folder, name=None, mkdir=False)

Write sky hemisphere to a sky_hemisphere.rad Radiance file.

Parameters
  • folder – Target folder.

  • name – File name.

  • mkdir – A boolean to note if the directory should be created if doesn’t exist (default: False).

Returns

Full path to the newly created file.

to_radiance()[source]

Radiance definition for SkyDome.

property ground_hemisphere

Sky ground glow source.

property is_climate_based

Return True if the sky is created based on values from weather data.

property is_point_in_time

Return True if the sky is generated for a single point in time.

property sky_density

Set and get sky subdivision density.

property sky_hemisphere

Sky hemisphere glow source.

class honeybee_radiance.lightsource.sky.skydome.UniformSky(ground_emittance=0.2)[source]

Bases: honeybee_radiance.lightsource.sky._skybase._SkyDome

Uniform sky is similar to a SkyDome but with no rfluxmtx header.

void glow sky_glow
0
0
4 1 1 1 0

sky_glow source sky
0
0
4 0 0 1 180

void glow ground_glow
0
0
4 0.2 0.2 0.2 0

ground_glow source ground
0
0
4 0 0 -1 180
Parameters

ground_emittance – Ground emittance value between 0.0 and 1.0 - Default: 0.2

ToString()

Overwrite .NET ToString.

classmethod from_dict(data)

Create the sky baseclass from a dictionary.

Parameters

data – A python dictionary in the following format

{
    'type': 'SkyDome',
    'ground_hemisphere': {},  # see ground.Ground class [optional],
    'sky_hemisphere': {}  # see hemisphere.Hemisphere class [optional]
}
to_dict()

Translate sky to a dictionary.

to_file(folder, name=None, mkdir=False)

Write sky hemisphere to a sky_hemisphere.rad Radiance file.

Parameters
  • folder – Target folder.

  • name – File name.

  • mkdir – A boolean to note if the directory should be created if doesn’t exist (default: False).

Returns

Full path to the newly created file.

to_radiance()[source]

Radiance definition for uniform sky.

property ground_hemisphere

Sky ground glow source.

property is_climate_based

Return True if the sky is created based on values from weather data.

property is_point_in_time

Return True if the sky is generated for a single point in time.

property sky_hemisphere

Sky hemisphere glow source.