honeybee_radiance_command.gensky module

Gensky command.

class honeybee_radiance_command.gensky.Gensky(month=None, day=None, time=None, time_zone=None, solar_time=False, options=None, output=None)[source]

Bases: Command

Gensky Command.

Gensky produces a RADIANCE scene description for the CIE standard sky distribution at the given month, day and time. By default, the time is interpreted as local standard time on a 24-hour clock. The time value may be given either as decimal hours, or using a colon to separate hours and minutes.

Parameters:

  • month – An integer representing the number of the month. Count starts from 01.

  • day – An integer representing the number of the day in a month. Count starts from 01.

  • time – A string representing hour and minute in 24 hours format. Examples of acceptable format are 21.30 and 21:30.

  • time_zone – A three letter text representing the time zone. Following are acceptable time zones with their corresponding hour differences from Greenwhich mean time; YST +9, PST +8, MST +7, CST +6, EST +5, GMT 0, CET -1, EET -2, AST -3, GST -4, IST -5.5, JST -9, NZST -12, YDT +8, PDT +7, MDT +6, CDT +5, EDT +4, BST -1, CEST -2, EEST -3, ADT -4, GDT -5, IDT -6.5, JDT -10, NZDT -13

  • solar_time – A boolean to use local solar time. If set to True then the time is preceded by ‘+’ sign and local solar time is used instead of local standard time.

  • options – Command options. It will be set to Radiance default values if unspecified.

  • output – File path to the output file (Default: None).

Properties

  • options

  • month

  • day

  • time

  • time_zone

  • solar_time

  • input

after_run()

After run script.

Overwrite this method to add extra tasks that runs right after run method.

enclose_command(stdin_input=False)

Enclose command in quotes and exclamation point (‘!’). This method should be used when reading the input of a command from another Radiance command.

Example: rmtxop -c 47.4 119.9 11.6 “!rmtxop view transmission daylight sky” > output

classmethod from_ang(angles, options=None)[source]

Create a Gensky command using sun altitude and azimuth angles in degrees.

The altitude is measured in degrees above the horizon, and the azimuth is measured in degrees west of South.

Parameters:

  • angles – A tuple of altitude and azimuth angles.

  • options – Command options. It will be set to Radiance default values if not provided by user.

run(env=None, cwd=None)

Run command as a subprocess.

Parameters:

  • env – Environmental variables (default: None).

  • cwd – Working directory (Default: ‘.’).

Returns:

Command return code.

Return type:

  • int

to_radiance(stdin_input=False)[source]

Command in Radiance format.

Parameters:

stdin_input – A boolean that indicates if the input for this command comes from stdin. This is for instance the case when you pipe the input from another command (default: False).

validate()[source]

Overwrite this method to add extra specific checks for the command. For instance for rcontrib you want to make sure there is at least one modifier set in the command.

This method will be executed right before running the command.

property command
property day

Day.

property input

Input string for gensky.

property month

Month.

property options

Gensky options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.

property solar_time

Whether solar time is requested.

property time

time.

property time_zone

time zone.