sky¶
honeybee-radiance sky¶
Commands to generate Radiance skies.
honeybee-radiance sky [OPTIONS] COMMAND [ARGS]...
abnt-nbr-15575¶
Generate four CIE skies for ABNT NBR 15575.
- The four skies are:
April 23rd at 9:30AM and 3:30PM.
October 23rd at 9:30AM and 3:30PM.
honeybee-radiance sky abnt-nbr-15575 [OPTIONS] WEA
Options
- -n, --north <north>¶
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West; 270 is East.
- Default:
0
- --folder <folder>¶
Output folder for the four generated .sky files.
- --log-file <log_file>¶
Optional log file to output the information about the four generated sky files. By default the list will be printed out to stdout.
Arguments
- WEA¶
Required argument
adjust-for-metric¶
Adjust a sky file to ensure it is suitable for a given metric.
Specifically, this ensures that skies being created with gendaylit have a -O option that aligns with visible vs. solar energy.
honeybee-radiance sky adjust-for-metric [OPTIONS] SKY
Options
- -m, --metric <metric>¶
Text for the type of metric to be output from the calculation. Choose from: illuminance, irradiance, luminance, radiance.
- Default:
'illuminance'
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
Arguments
- SKY¶
Required argument
cie¶
Get a CIE sky file from parameters.
These can be a minimal representation of the sky through altitude and azimuth (eg. “cie -alt 71.6 -az 185.2 -type 0”). Or it can be a detailed specification of time and location (eg. “cie 21 Jun 12:00 -lat 41.78 -lon -87.75 -type 0”). Both the altitude and azimuth must be specified for the minimal representation to be used. Otherwise, this command defaults to the detailed specification of time and location.
honeybee-radiance sky cie [OPTIONS] [DAY] [MONTH] [TIME]
Options
- -lat, --latitude <latitude>¶
Location latitude between -90 (south) and 90 (north).
- Default:
0
- -lon, --longitude <longitude>¶
Location longitude between -180 (west) and 180 (east).
- Default:
0
- -tz, --time-zone <time_zone>¶
Time zone between -12 hours (west) and +14 hours (east). If unspecified, the time will be interpreted as solar time at the given longitude.
- -type, --sky-type <sky_type>¶
An integer from 0-5 to indicate CIE Sky Type. 0 = Sunny with sun, 1 = Sunny without sun, 2 = Intermediate with sun, 3 = Intermediate without sun, 4 = Cloudy sky, 5 = Uniform cloudy sky.
- Default:
0
- -n, --north <north>¶
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West; 270 is East
- Default:
0
- -g, --ground <ground>¶
Fractional value for ground reflectance.
- Default:
0.2
- -alt, --altitude <altitude>¶
Solar altitude measured in degrees above the horizon.
- -az, --azimuth <azimuth>¶
Solar azimuth measured in degrees east of North. East is 90, South is 180 and West is 270. Note that this is different from Radiance convention where the azimuth degrees are measured in west of South.
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
Arguments
- DAY¶
Optional argument
- MONTH¶
Optional argument
- TIME¶
Optional argument
climate-based¶
Get a ClimateBased sky file from parameters.
These can be a minimal representation of the sky through altitude and azimuth (eg. “climate-based -alt 71.6 -az 185.2 -dni 800 -dhi 120”). Or it can be a detailed specification of time and location (eg. “climate-based 21 Jun 12:00 -lat 41.78 -lon -87.75 -dni 800 -dhi 120”). Both the altitude and azimuth must be specified for the minimal representation to be used. Otherwise, this command defaults to the detailed specification of time and location.
honeybee-radiance sky climate-based [OPTIONS] [DAY] [MONTH] [TIME]
Options
- -lat, --latitude <latitude>¶
Location latitude between -90 (south) and 90 (north).
- Default:
0
- -lon, --longitude <longitude>¶
Location longitude between -180 (west) and 180 (east).
- Default:
0
- -tz, --time-zone <time_zone>¶
Time zone between -12 hours (west) and +14 hours (east). If unspecified, the time will be interpreted as solar time at the given longitude.
- -dni, --direct-normal-irradiance <direct_normal_irradiance>¶
Direct normal irradiance (W/m2).
- Default:
0
- -dhi, --diffuse_horizontal_irradiance <diffuse_horizontal_irradiance>¶
Diffuse horizontal irradiance (W/m2).
- Default:
0
- -n, --north <north>¶
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West; 270 is East
- Default:
0
- -g, --ground <ground>¶
Fractional value for ground reflectance.
- Default:
0.2
- -alt, --altitude <altitude>¶
Solar altitude measured in degrees above the horizon.
- -az, --azimuth <azimuth>¶
Solar azimuth measured in degrees east of North. East is 90, South is 180 and West is 270. Note that this is different from Radiance convention where the azimuth degrees are measured in west of South.
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
Arguments
- DAY¶
Optional argument
- MONTH¶
Optional argument
- TIME¶
Optional argument
illuminance¶
Generate an overcast / cloudy sky with certain illuminance value.
honeybee-radiance sky illuminance [OPTIONS] [ILLUM]
Options
- -g, --ground <ground>¶
Fractional value for ground reflectance.
- Default:
0.2
- -u, --cloudy, --uniform¶
Flag to note whether the sky is uniform instead of cloudy.
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
Arguments
- ILLUM¶
Optional argument
irradiance¶
Generate an overcast / cloudy sky with certain irradiance value.
honeybee-radiance sky irradiance [OPTIONS] [IRRAD]
Options
- -g, --ground <ground>¶
Fractional value for ground reflectance.
- Default:
0.2
- -u, --cloudy, --uniform¶
Flag to note whether the sky is uniform instead of cloudy.
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
Arguments
- IRRAD¶
Optional argument
leed-illuminance¶
Generate two climate-based lear skies for LEED v4.1 Daylight Option 2.
This involves evaluating the input TMY Wea, finding the clearest day within 15 days of September and March, and using that to generate skies at 9AM and 3PM.
honeybee-radiance sky leed-illuminance [OPTIONS] WEA
Options
- -n, --north <north>¶
A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West; 270 is East
- Default:
0
- --folder <folder>¶
Output folder for the two generated .sky files.
- --name <name>¶
Sky file base name. Each of the two output skies will have this base name concatenated with 9AM or 3PM
- Default:
''
- --log-file <log_file>¶
Optional log file to output the information about the two generated sky files. By default the list will be printed out to stdout
Arguments
- WEA¶
Required argument
mtx¶
Generate a climate-based sky matrix from a Wea file using radiance’s gendaymtx.
honeybee-radiance sky mtx [OPTIONS] WEA
Options
- --north <north>¶
Angle to north (0-360). 90 is west and 270 is east
- Default:
0
- --sky-type <sky_type>¶
- Options:
sun-only | no-sun | total
- --sky-density <sky_density>¶
The density of generated sky. This input corresponds to gendaymtx -m option. -m 1 generates 146 patch starting with 0 for the ground and continuing to 145 for the zenith. Increasing the -m parameter yields a higher resolution sky using the Reinhart patch subdivision. For example, setting -m 4 yields a sky with 2305 patches plus one patch for the ground.
- --output-format <output_format>¶
- Options:
float | double | ASCII
- --hourly, --cumulative¶
Flag to generate a cumulative or hourly sky.
- --visible, --solar¶
A flag to indicate the output type. Visible is equal to -O0 and solar is -O1 in gendaymtx options. Default: visible.
- --all-hours, --sun-up-hours¶
A flag to indicate if only sun up hours should be included in the sky. By default all the hours from the input wea file will be included.
- --folder <folder>¶
Output folder.
- --name <name>¶
File name.
- --log-file <log_file>¶
Optional log file to output the name of the newly created modifier files. By default the list will be printed out to stdout
- --dry-run¶
A flag to show the command without running it.
- Default:
False
Arguments
- WEA¶
Required argument
skydome¶
Virtual skydome for daylight coefficient studies with constant radiance.
Use this sky to calculate daylight matrix.
honeybee-radiance sky skydome [OPTIONS]
Options
- --sky-density <sky_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
- Default:
1
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
uniform-sky¶
Virtual skydome with uniform characteristics.
This sky is usually used to create an octree that is sent to rcontrib command.
honeybee-radiance sky uniform-sky [OPTIONS]
Options
- -g, --ground-emittance <ground_emittance>¶
Ground emittance value.
- Default:
0.2
- --folder <folder>¶
Output folder.
- Default:
'.'
- --name <name>¶
Sky file name.
- Default:
'uniform_sky'