honeybee_plus.radiance.sky.analemma module

Solar analemma.

class honeybee_plus.radiance.sky.analemma.Analemma(sun_vectors, sun_up_hours)[source]

Bases: honeybee_plus.radiance.sky._skyBase.RadianceSky

Generate a radiance-based analemma.

Use Analemma for solar access/sunlight hours studies. For annual daylight/radiation studies see AnalemmaReversed.

Analemma consists of two files:

  1. *.ann file which includes sun geometries and materials.

  2. *.mod file includes list of modifiers that are included in *.ann file.

ToString()[source]

Overwrite .NET ToString method.

property analemma_file

Analemma file name.

Use this file to create the octree.

duplicate()[source]

Duplicate this class.

execute(working_dir)[source]

Execute the sky and write the results to a file if desired.

classmethod from_epw_file(epw_file, hoys=None, north=0, is_leap_year=False)[source]

Create sun matrix from an epw file.

NOTE: Only the location from epw file will be used for creating analemma. For

climate-based sun materix see SunMatrix class.

Parameters

  • epw_file – Full path to an epw file.

  • hoys – A list of hours of the year (default: range(8760)).

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

classmethod from_epw_file_sun_up_hours(epw_file, sun_up_hours, north=0, is_leap_year=False)[source]

Create sun matrix from an epw file.

NOTE: Only the location from epw file will be used for creating analemma. For

climate-based sun materix see SunMatrix class.

Parameters

  • epw_file – Full path to an epw file.

  • sun_up_hours – A list of hours of the year to be included in analemma.

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

classmethod from_json(inp)[source]

Create an analemma from a dictionary.

classmethod from_location(location, hoys=None, north=0, is_leap_year=False)[source]

Generate a radiance-based analemma for a location.

Parameters

  • location – A ladybug location.

  • hoys – A list of hours of the year (default: range(8760)).

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

classmethod from_location_sun_up_hours(location, sun_up_hours, north=0, is_leap_year=False)[source]

Generate a radiance-based analemma for a location.

Parameters

  • location – A ladybug location.

  • sun_up_hours – A list of hours of the year to be included in analemma.

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

classmethod from_wea(wea, hoys=None, north=0, is_leap_year=False)[source]

Generate a radiance-based analemma from a ladybug wea.

NOTE: Only the location from wea will be used for creating analemma. For

climate-based sun materix see SunMatrix class.

Parameters

  • wea – A ladybug Wea.

  • sun_up_hours – A list of hours of the year to be included in analemma.

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

classmethod from_wea_sun_up_hours(wea, sun_up_hours, north=0, is_leap_year=False)[source]

Generate a radiance-based analemma from a ladybug wea.

NOTE: Only the location from wea will be used for creating analemma. For

climate-based sun materix see SunMatrix class.

Parameters

  • wea – A ladybug Wea.

  • sun_up_hours – A list of hours of the year to be included in analemma.

  • north – North angle from Y direction (default: 0).

  • is_leap_year – A boolean to indicate if hours are for a leap year (default: False).

property isAnalemma

Return True.

property is_climate_based

Return True if generated based on values from weather file.

property sun_up_hours

Return list of hours for sun vectors.

property sun_vectors

Return list of sun vectors.

property sunlist_file

Sun list file name.

Use this file as the list of modifiers in rcontrib.

to_json()[source]

Convert analemma to a dictionary.

to_rad_string()[source]

Get the radiance command line as a string.

class honeybee_plus.radiance.sky.analemma.AnalemmaReversed(sun_vectors, sun_up_hours)[source]

Bases: honeybee_plus.radiance.sky.analemma.Analemma

Generate a radiance-based analemma.

Reversed Analemma reverses direction of input sun vectors. Use reversed Analemma for radiation and daylight studies.

Analemma consists of two files:

  1. *_reversed.ann file which includes sun geometries and materials.

2. *.mod file includes list of modifiers that are included in *_reversed.ann file.

property analemma_file

Analemma file name.

Use this file to create the octree.

execute(working_dir)[source]

Execute the sky and write the results to a file if desired.