ladybug_display.extension.sunpath module

Method to draw a Sunpath as a VisualizationSet.

ladybug_display.extension.sunpath.sunpath_to_vis_set(sunpath, hoys=None, data=None, legend_parameters=None, radius=100, center_point=Point3D(0.0, 0.0, 0.0), solar_time=False, daily=False, projection=None, sun_spheres=False)[source]

Get a Ladybug Sunpath represented as a VisualizationSet.

Parameters

  • sunpath – A Ladybug Sunpath object.

  • hoys – An optional list of numbers between 0 and 8760 that represent the hours of the year at which the sun position will be displayed. The Ladybug AnalysisPeriod class can output a list of HOYs within a certain hour or date range. (Default: None).

  • data – An optional list of hourly data collection objects, which will generate colored sun positions for each of the hoys.

  • legend_parameters – An optional LegendParameter object or list of LegendParameter objects to customize the display of the data on the sun path. If a list is used, these should align with the input data (one legend parameter per data collection).

  • radius – Number for the radius of the sun path. (Default: 100).

  • center_point – Point3D for the center of the sun path. (Default: (0, 0, 0)).

  • solar_time – A boolean to indicate if the sunpath should be drawn with solar time hours instead of standard or daylight time. (Default: False)

  • daily – Boolean to note whether the sunpath should display only one daily arc for each unique day in the input hoys_ (True) or whether the output sun path geometry should be for the entire year, complete with analemmas for all sun-up hours and a daily arc for each month (False). (Default: False)

  • projection –

    Optional text for the name of a projection to use from the sky dome hemisphere to the 2D plane. If None, a 3D sun path will be drawn instead of a 2D one. (Default: None) Choose from the following:

    • Orthographic

    • Stereographic

  • sun_spheres – Boolean to note whether sun positions should be drawn as points or as fully-detailed spheres. Note that this option should only be used when there are relatively few hoys input. Anything more than 100 hoys can make the display very slow. (Default: False).

Returns

A VisualizationSet with the Sunpath represented several ContextGeometries (and optionally an AnalysisGeometry if data is input). This includes these objects in the following order.

  • Compass – A ContextGeometry for the Compass at the base of the sunpath.

  • Analemmas – A ContextGeometry for the analemmas of the sunpath (if

    the daily input is False).

  • Daily_Arcs – A ContextGeometry for the daily arcs across the sunpath.

  • Sun_Positions – Either a ContextGeometry or an AnalysisGeometry for

    the sun positions (if hoys are input). The object will be an AnalysisGeometry if data is input, indicating that suns are colored with this data.