honeybee_plus.radiance.parameters.gensky module¶
-
class
honeybee_plus.radiance.parameters.gensky.
GenskyParameters
(*args, **kwargs)[source]¶ Bases:
honeybee_plus.radiance.parameters._advancedparametersbase.AdvancedRadianceParameters
Gensky parameters.
-
altitude_azimuth
¶ [-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.
-
sunny_sky
¶ [-s|+s] A boolean value to generate sunny sky with or without sun. Set to True to generate a sunnny sky with sun, Fasle to generate a sunny sky without sun (Default: None)
-
cloudy_sky
¶ [-c] A boolean value to generate cloudy sky
-
interm_sky
¶ [-i|+i] A boolean value to generate intermediate sky with or without sun. Set to True to generate an intermediate sky with sun, Fasle to generate a intermediate sky without sun (Default: None)
-
uniform_cloudy_sky
¶ [-u] A boolean value to generate Uniform cloudy sky.
-
ground_reflect
¶ [-g rfl] A float number to indicate ground reflectance.
-
zenith_bright
¶ [-b brt] A float number to indicate zenith brightness in watts/steradian/meter-sq.
-
zenith_bright_horz_diff
¶ [-B irrad] A float number to indicate zenith brightness from horizontal diffuse irradiance in watts/meter-sq.
-
solar_rad
¶ [-r rad] A float number to indicate solar radiance in
-
watts/steradians/meter-sq.
-
solar_rad_horz_diff
¶ [-R irrad] A float number to indicate solar radiance from horizontal direct irradiance in watts/meter-sq.
-
turbidity
¶ [-t trb] A float number to indicate turbidity.
-
latitude
¶ [-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.
-
longitude
¶ [-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.
-
meridian
¶ [-m mer] A float number to indicate site meridian west of
-
Greenwich.
-
\* For the full list of attributes try self.keys
-
\*\* values between []'s indicate Radiance equivalent keys for advanced users
Usage:
# generate sky matrix with default values gnskyparam = GenskyParameters()
# check the current values print(gnskyparam.to_rad_string()) > -g 0.5
# set altitude and azimuth angle values gnsky.altitude_azimuth = (12,31)
#check the new values added. print(gnskyparam.to_rad_string()) > -g 0.5 -ang 12.0 31.0
-
altitude_azimuth
¶ [-ang] A tuple corresponding to altitude and azimuth angle.This input can be used instead of specifying the monthDayTime.
-
cloudy_sky
¶ [-c] A boolean value to generate cloudy sky
-
freeze
()¶
-
ground_reflect
¶ [-g rfl] A float number to indicate ground reflectance
-
interm_sky
¶ [-i|+i] A boolean value to generate intermediate sky with or without sun. Set to True to generate an intermediate sky with sun, Fasle to generate a intermediate sky without sun (Default: None)
-
latitude
¶ [-a lat] A float number to indicate site altitude. Negative angle indicates south latitude.
-
longitude
¶ [-o lon] A float number to indicate site latitude. Negative angle indicates east longitude.
-
meridian
¶ [-m mer] A float number to indicate site meridian west of Greenwich.
-
solar_rad
¶ [-r rad] A float number to indicate solar radiance in watts/steradians/meter-sq.
-
solar_rad_horz_diff
¶ [-R irrad] A float number to indicate solar radiance from horizontal direct irradiance in watts/meter-sq.
-
sunny_sky
¶ [-s|+s] A boolean value to generate sunny sky with or without sun. Set to True to generate a sunnny sky with sun, Fasle to generate a sunny sky without sun (Default: None)
-
turbidity
¶ [-t trb] A float number to indicate turbidity.
-
unfreeze
()¶
-
uniform_cloudy_sky
¶ [-u] A boolean value to generate Uniform cloudy sky.
-
zenith_bright
¶ [-b brt] A float number to indicate zenith brightness in watts/steradian/meter-sq.
-
zenith_bright_horz_diff
¶ [-B irrad] A float number to indicate zenith brightness from horizontal diffuse irradiance in watts/meter-sq.
-