honeybee_radiance_command.options.gensky module

class honeybee_radiance_command.options.gensky.GenskyOptions

Bases: OptionCollection

Gensky command options.

Also see: https://floyd.lbl.gov/radiance/man_html/gensky.1.html

to_file(folder, file_name, mkdir=False)

Write options to a file.

to_radiance()

Translate options to Radiance format.

update_from_string(string)

Update options from a standard radiance string.

If the option is not currently part of the collection, it will be added to additional_options.

property B

Zenith brightness computed from horizontal diffuse irradiance.

In this option, zenith brightness is computed from the horizontal diffuse irradiance (in watts/meter2).

property R

Solar radiance computed from horizontal direct irradiance.

Solar radiance is computed from the horizontal direct irradiance (in watts/meter2).

property a

Site latitude.

The value is site latitude in degrees north. (Use negative angle for south latitude.) This is used in the calculation of sun angle

additional_options

property ang

Altitude & azimuth

This option gives the solar angles explicitly. The altitude is measured in degrees above the horizon, and the azimuth is measured in degrees west of south.

property b

Zenith brightness computed from sun and sky turbidity.

Zenith radiance (in watts/steradian/meter2) is normally computed from the sun angle and sky turbidity (for sunny sky). It can be given directly instead, using this option.

property c

Cloudy sky.

The sky distribution will correspond to a standard CIE overcast day.

property command

Command name.

property g

Average ground reflectance.

This value is used to compute skyfunc when Dz is negative. Ground plane brightness is the same for −s as for +s. (Likewise for −i and +i)

property i

Intermediate sky.

Setting it to ‘+’ will create an intermediate sky with sun. Setting it to ‘-’ will create an intermediate sky without sun. The sky will correspond to a standard CIE intermediate day. If set to true, in addition to the sky distribution, a (somewhat subdued) sun is generated.

property m

Standard meridian.

The site standard meridian is a value in degrees west of Greenwich. (Use negative angle for east.) This is used in the calculation of solar time. Be sure to give the correct longitude also! If a time zone or solar time is given directly, then this option has no effect.

property o

Site longitude.

The value is site longitude in degrees west. (Use negative angle for east longitude.) This is used in the calculation of solar time and sun angle. Be sure to give the corresponding standard meridian also! If solar time is given directly, then this option has no effect.

property options

Print out list of options.

property r

Solar radiance computed from solar altitude.

The value is solar radiance. Solar radiance (in watts/steradian/meter2) is normally computed from the solar altitude. This option may be used to override the default calculation. If a value of zero is given, no sun description is produced, and the contribution of direct solar to ground brightness is neglected.

property s

Sunny sky.

Setting it to ‘+’ will create a sunny sky with sun. Setting it to ‘-’ will create a sunny sky without sun. The sky distribution will correspond to a standard CIE clear day. If set to true, in addition to the sky distribution function, a source description of the sun is generated.

property slots

Return slots including the ones from the baseclass if any.

property t

Turbuity factor.

The value is turbidity factor. Greater turbidity factors correspond to greater atmospheric scattering. A turbidity factor of 1.0 indicates an ideal clear atmosphere (i.e. a completely dark sky). Values less than 1.0 are physically impossible.

property u

Uniform cloudy sky.

The sky distribution will be completely uniform