honeybee_radiance.lightsource.sky.strutil module

Utilities to convert sky strings to Python objects.

honeybee_radiance.lightsource.sky.strutil.string_to_sky(sky_string, raise_exception=True)[source]

Get a Python object of any sky from a string representation.

Parameters
  • sky_string – A text string representing a CIE, ClimateBased, or CertainIrradiance sky. This can be a minimal representation of the sky (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”).

  • raise_exception – Boolean to note whether an excpetion should be raised if the object is not identified as a sky. Default: True.

Returns

A Python object derived from the input sky_string.