sunpath

honeybee-radiance sunpath

Commands to generate Radiance Sunpath.

honeybee-radiance sunpath [OPTIONS] COMMAND [ARGS]...

epw

Generate a climate-based sunpath from an epw weather file.

This command also generates a mod file which includes all the modifiers in sunpath. mod file is usually used with rcontrib command to indicate the list of modifiers. Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files will be broken down into multiple files if number of modifiers is more than 10000 modifiers.

epw: Path to a epw file.

honeybee-radiance sunpath epw [OPTIONS] EPW

Options

--north <north>

Angle to north (0-360). 90 is west and 270 is east

Default

0

--start-date <start_date>

Start date as MMM-DD (e.g JUL-21). Start date itself will also be included.

Default

JAN-01

--start-time <start_time>

Start time as HH:MM (e.g 14:10). Start time itself will also be included.

Default

00:00

--end-date <end_date>

End date as MMM-DD (e.g JUL-21). End date itself will also be included.

Default

DEC-31

--end-time <end_time>

End time as HH:MM (e.g 18:30). End time itself will also be included.

Default

23:00

--timestep <timestep>

An optional integer to set the number of time steps per hour. Default is 1 for one value per hour.

Default

1

--leap-year, -fy, --full-year

Flag for whether input epw is for a leap year.

--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

--reverse-vectors

Reverse sun vectors to go from ground to sky.

Arguments

EPW

Required argument

location

Generate a non climate-based sunpath for a location.

This command also generates a mod file which includes all the modifiers in sunpath. mod file is usually used with rcontrib command to indicate the list of modifiers. Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files will be broken down into multiple files if number of modifiers is more than 10000 modifiers.

honeybee-radiance sunpath location [OPTIONS]

Options

--lat <lat>

The latitude of the location in degrees. Values must be between -90 and 90. Default is set to the equator.

Default

0

--lon <lon>

The longitude of the location in degrees

Default

0

--tz <tz>

A number representing the time zone of the location you are constructing. This can improve the accuracy of the resulting sun plot. The time zone should follow the epw convention and should be between -12 and +12, where 0 is at Greenwich, UK, positive values are to the East of Greenwich and negative values are to the West.

Default

0

--north <north>

Angle to north (0-360). 90 is west and 270 is east

Default

0

--start-date <start_date>

Start date as MMM-DD (e.g JUL-21). Start date itself will also be included.

Default

JAN-01

--start-time <start_time>

Start time as HH:MM (e.g 14:10). Start time itself will also be included.

Default

00:00

--end-date <end_date>

End date as MMM-DD (e.g JUL-21). End date itself will also be included.

Default

DEC-31

--end-time <end_time>

End time as HH:MM (e.g 18:30). End time itself will also be included.

Default

23:00

--timestep <timestep>

An optional integer to set the number of time steps per hour. Default is 1 for one value per hour.

Default

1

--leap-year, -fy, --full-year

Flag for whether to use a leap year.

--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

--reverse-vectors

Reverse sun vectors to go from ground to sky.

parse-hours

Parse hours of the year from a suns modifier file generated by Radiance’s gendaymtx.

suns: Path to a suns modifiers file.

honeybee-radiance sunpath parse-hours [OPTIONS] SUNS

Options

--timestep <timestep>

This input is not used and is deprecated.

Default

1

--leap-year, -fy, --full-year

This input is not used and is deprecated.

--folder <folder>

Output folder.

--name <name>

Output file name.

Arguments

SUNS

Required argument

radiance

Generate a climate-based sunpath from a Wea file using radiance’s gendaymtx.

This command also generates a mod file which includes all the modifiers in sunpath. mod file is usually used with rcontrib command to indicate the list of modifiers. Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files will be broken down into multiple files if number of modifiers is more than 10000 modifiers.

Args:
wea: Path to a wea file. This can also be an epw file.
honeybee-radiance sunpath radiance [OPTIONS] WEA

Options

--north <north>

Angle to north (0-360). 90 is west and 270 is east

Default

0

--folder <folder>

Output folder.

--name <name>

File name.

--visible, --solar

A flag to indicate the output type. Visible is equal to -O0 and solar is -O1 in gendaymtx options. Default: visible.

--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

wea

Generate a climate-based sunpath from a Wea file.

This command also generates a mod file which includes all the modifiers in sunpath. mod file is usually used with rcontrib command to indicate the list of modifiers. Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files will be broken down into multiple files if number of modifiers is more than 10000 modifiers.

wea: Path to a wea file.

honeybee-radiance sunpath wea [OPTIONS] WEA

Options

--north <north>

Angle to north (0-360). 90 is west and 270 is east

Default

0

--timestep <timestep>

An integer to set the number of time steps per hour in the wea. Default is 1 for one value per hour.

Default

1

--leap-year, -fy, --full-year

Flag for whether input wea is for a leap year.

--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

--reverse-vectors

Reverse sun vectors to go from ground to sky.

Arguments

WEA

Required argument