ladybug_comfort.collection.solarcal module

Objects for calculating solar-adjusted MRT from DataCollections.

class ladybug_comfort.collection.solarcal.HorizontalRefSolarCal(location, direct_horizontal_solar, diffuse_horizontal_solar, reflected_horizontal_solar, longwave_mrt, fraction_body_exposed=None, solarcal_body_parameter=None)[source]

Bases: _SolarCalBase

SolarCal Collection object from all horizontal components (including reflection).

This is particularly useful when trying to estimate solar MRT deltas from Radiance radiation simulation result.

Parameters:

  • location – A Ladybug Location object.

  • direct_horizontal_solar – Hourly Data Collection with the direct horizontal solar irradiance in W/m2.

  • diffuse_horizontal_solar – Hourly Data Collection with the diffuse horizontal solar irradiance in W/m2.

  • reflected_horizontal_solar – Hourly Data Collection with the ground-reflected horizontal solar irradiance in W/m2.

  • longwave_mrt – Hourly Data Collection or individual value with the longwave mean radiant temperature (MRT) expereinced as a result of indoor surface temperatures in C.

  • fraction_body_exposed – A Data Collection or number between 0 and 1 representing the fraction of the body exposed to direct sunlight. Note that this does not include the body’s self-shading; only the shading from surroundings. Default is 1 for a person standing in an open area.

  • solarcal_body_parameter – Optional SolarCalParameter object to account for properties of the human geometry.

Properties:

  • location

  • direct_horizontal_solar

  • diffuse_horizontal_solar

  • reflected_horizontal_solar

  • longwave_mrt

  • fraction_body_exposed

  • solarcal_body_parameter

  • effective_radiant_field

  • mrt_delta

  • mean_radiant_temperature

ToString()

Overwrite .NET ToString.

property calc_length

The number of values in the Data Collections of this object.

property comfort_model

Return the name of the model to which the comfort datacollection belongs.

property diffuse_horizontal_solar

Data Collection of diffuse horizontal irradiance in Wh/m2 or W/m2.

property direct_horizontal_solar

Data Collection of direct horizontal irradiance in Wh/m2 or W/m2.

property effective_radiant_field

Data Collection of shortwave effective radiant field in W/m2.

property floor_reflectance

Data Collection of floor reflectance.

property fraction_body_exposed

Data Collection of body fraction exposed to direct sun.

property location

Ladybug Location object.

property longwave_mrt

Data Collection of surface temperature values in degrees C.

property mean_radiant_temperature

Data Collection of total mean radiant temperature in C.

property mrt_delta

Data Collection of shortwave MRT delta in C.

property percent_cold

The percent of time that the thermal_condition is cold.

property percent_hot

The percent of time that the thermal_condition is hot.

property percent_neutral

The percent of time that the thermal_condition is neutral.

property reflected_horizontal_solar

Data Collection of direct horizontal irradiance in Wh/m2 or W/m2.

property solarcal_body_parameter

SolarCal body parameters that are assigned to this object.

class ladybug_comfort.collection.solarcal.HorizontalSolarCal(location, direct_horizontal_solar, diffuse_horizontal_solar, longwave_mrt, fraction_body_exposed=None, floor_reflectance=None, solarcal_body_parameter=None)[source]

Bases: _SolarCalBase

SolarCal Collection object from horizontal solar components.

This is particularly useful when trying to estimate solar MRT deltas from Radiance radiation simulation result.

Parameters:

  • location – A Ladybug Location object.

  • direct_horizontal_solar – Hourly Data Collection with the direct horizontal solar irradiance in W/m2.

  • diffuse_horizontal_solar – Hourly Data Collection with the diffuse horizontal solar irradiance in W/m2.

  • longwave_mrt – Hourly Data Collection or individual value with the longwave mean radiant temperature (MRT) expereinced as a result of indoor surface temperatures in C.

  • fraction_body_exposed – A Data Collection or number between 0 and 1 representing the fraction of the body exposed to direct sunlight. Note that this does not include the body’s self-shading; only the shading from surroundings. Default is 1 for a person standing in an open area.

  • floor_reflectance – A Data Collection or number between 0 and 1 that represents the reflectance of the floor. Default is for 0.25 which is characteristic of outdoor grass or dry bare soil.

  • solarcal_body_parameter – Optional SolarCalParameter object to account for properties of the human geometry.

Properties:

  • location

  • direct_horizontal_solar

  • diffuse_horizontal_solar

  • longwave_mrt

  • fraction_body_exposed

  • floor_reflectance

  • solarcal_body_parameter

  • effective_radiant_field

  • mrt_delta

  • mean_radiant_temperature

ToString()

Overwrite .NET ToString.

property calc_length

The number of values in the Data Collections of this object.

property comfort_model

Return the name of the model to which the comfort datacollection belongs.

property diffuse_horizontal_solar

Data Collection of diffuse horizontal irradiance in Wh/m2 or W/m2.

property direct_horizontal_solar

Data Collection of direct horizontal irradiance in Wh/m2 or W/m2.

property effective_radiant_field

Data Collection of shortwave effective radiant field in W/m2.

property floor_reflectance

Data Collection of floor reflectance.

property fraction_body_exposed

Data Collection of body fraction exposed to direct sun.

property location

Ladybug Location object.

property longwave_mrt

Data Collection of surface temperature values in degrees C.

property mean_radiant_temperature

Data Collection of total mean radiant temperature in C.

property mrt_delta

Data Collection of shortwave MRT delta in C.

property percent_cold

The percent of time that the thermal_condition is cold.

property percent_hot

The percent of time that the thermal_condition is hot.

property percent_neutral

The percent of time that the thermal_condition is neutral.

property solarcal_body_parameter

SolarCal body parameters that are assigned to this object.

class ladybug_comfort.collection.solarcal.IndoorSolarCal(location, direct_normal_solar, diffuse_horizontal_solar, longwave_mrt, fraction_body_exposed=None, sky_exposure=None, floor_reflectance=None, window_transmittance=None, solarcal_body_parameter=None)[source]

Bases: _SolarCalBase

Indoor SolarCal Collection object.

Parameters:

  • location – A Ladybug Location object.

  • direct_normal_solar – Hourly Data Collection with the direct normal solar irradiance in W/m2.

  • diffuse_horizontal_solar – Hourly Data Collection with the diffuse horizontal solar irradiance in W/m2.

  • longwave_mrt – Hourly Data Collection or individual value with the longwave mean radiant temperature (MRT) expereinced as a result of indoor surface temperatures in C.

  • fraction_body_exposed – A Data Collection or number between 0 and 1 representing the fraction of the body exposed to direct sunlight. Note that this does not include the body’s self-shading; only the shading from surroundings. Default is 1 for a person standing in an open area.

  • sky_exposure – A Data Collection or number between 0 and 1 representing the fraction of the sky vault in occupant’s view. Default is 1 for a person standing in an open area.

  • floor_reflectance – A Data Collection or number between 0 and 1 that represents the reflectance of the floor. Default is for 0.25 which is characteristic of outdoor grass or dry bare soil.

  • window_transmittance – A Data Collection or number between 0 and 1 that represents the broadband solar transmittance of the window through which the sun is coming. Such values tend to be slightly less than the SHGC. Values might be as low as 0.2 and could be as high as 0.85 for a single pane of glass. Default is 0.4 assuming a double pane window with a relatively mild low-e coating.

  • solarcal_body_parameter – Optional SolarCalParameter object to account for properties of the human geometry.

Properties:

  • location

  • direct_normal_solar

  • diffuse_horizontal_solar

  • longwave_mrt

  • fraction_body_exposed

  • sky_exposure

  • floor_reflectance

  • window_transmittance

  • solarcal_body_parameter

  • effective_radiant_field

  • mrt_delta

  • mean_radiant_temperature

ToString()

Overwrite .NET ToString.

property calc_length

The number of values in the Data Collections of this object.

property comfort_model

Return the name of the model to which the comfort datacollection belongs.

property diffuse_horizontal_solar

Data Collection of diffuse horizontal irradiance in Wh/m2 or W/m2.

property direct_normal_solar

Data Collection of direct normal irradiance in Wh/m2 or W/m2.

property effective_radiant_field

Data Collection of shortwave effective radiant field in W/m2.

property floor_reflectance

Data Collection of floor reflectance.

property fraction_body_exposed

Data Collection of body fraction exposed to direct sun.

property location

Ladybug Location object.

property longwave_mrt

Data Collection of surface temperature values in degrees C.

property mean_radiant_temperature

Data Collection of total mean radiant temperature in C.

property mrt_delta

Data Collection of shortwave MRT delta in C.

property percent_cold

The percent of time that the thermal_condition is cold.

property percent_hot

The percent of time that the thermal_condition is hot.

property percent_neutral

The percent of time that the thermal_condition is neutral.

property sky_exposure

Data Collection of sky view.

property solarcal_body_parameter

SolarCal body parameters that are assigned to this object.

property window_transmittance

Data Collection of window transmittance.

class ladybug_comfort.collection.solarcal.OutdoorSolarCal(location, direct_normal_solar, diffuse_horizontal_solar, horizontal_infrared, surface_temperatures, fraction_body_exposed=None, sky_exposure=None, floor_reflectance=None, solarcal_body_parameter=None)[source]

Bases: _SolarCalBase

Outdoor SolarCal Collection object.

Parameters:

  • location – A Ladybug Location object.

  • direct_normal_solar – Hourly Data Collection with the direct normal solar irradiance in W/m2.

  • diffuse_horizontal_solar – Hourly Data Collection with the diffuse horizontal solar irradiance in W/m2.

  • surface_temperatures – Hourly Data Collection with the temperature of surfaces around the person in degrees Celsius. This includes the ground and any other surfaces blocking the view to the sky. When the temperature of these individual surfaces are known, the input here should be the average temperature of the surfaces weighted by view-factor to the human. When such individual surface temperatures are unknown, the outdoor dry bulb temperature is typically used as a proxy.

  • horizontal_infrared – Hourly Data Collection with the horizontal infrared radiation intensity from the sky in W/m2.

  • fraction_body_exposed – A Data Collection or number between 0 and 1 representing the fraction of the body exposed to direct sunlight. Note that this does not include the body’s self-shading; only the shading from surroundings. Default is 1 for a person standing in an open area.

  • sky_exposure – A Data Collection or number between 0 and 1 representing the fraction of the sky vault in occupant’s view. Default is 1 for a person standing in an open area.

  • floor_reflectance – A Data Collection or number between 0 and 1 that represents the reflectance of the floor. Default is for 0.25 which is characteristic of outdoor grass or dry bare soil.

  • solarcal_body_parameter – Optional SolarCalParameter object to account for properties of the human geometry.

Properties:

  • location

  • direct_normal_solar

  • diffuse_horizontal_solar

  • horizontal_infrared

  • surface_temperatures

  • fraction_body_exposed

  • sky_exposure

  • floor_reflectance

  • solarcal_body_parameter

  • shortwave_effective_radiant_field

  • longwave_effective_radiant_field

  • shortwave_mrt_delta

  • longwave_mrt_delta

  • mrt_delta

  • mean_radiant_temperature

ToString()

Overwrite .NET ToString.

property calc_length

The number of values in the Data Collections of this object.

property comfort_model

Return the name of the model to which the comfort datacollection belongs.

property diffuse_horizontal_solar

Data Collection of diffuse horizontal irradiance in W/m2.

property direct_normal_solar

Data Collection of direct normal irradiance in W/m2.

property floor_reflectance

Data Collection of floor reflectance.

property fraction_body_exposed

Data Collection of body fraction exposed to direct sun.

property horizontal_infrared

Data Collection of horizontal infrared radiation intensity in W/m2.

property location

Ladybug Location object.

property longwave_effective_radiant_field

Data Collection of longwave effective radiant field in W/m2.

property longwave_mrt_delta

Data Collection of longwave MRT delta in C.

property mean_radiant_temperature

Data Collection of total mean radiant temperature in C.

property mrt_delta

Data Collection of total MRT delta in C.

property percent_cold

The percent of time that the thermal_condition is cold.

property percent_hot

The percent of time that the thermal_condition is hot.

property percent_neutral

The percent of time that the thermal_condition is neutral.

property shortwave_effective_radiant_field

Data Collection of shortwave effective radiant field in W/m2.

property shortwave_mrt_delta

Data Collection of shortwave MRT delta in C.

property sky_exposure

Data Collection of sky view.

property solarcal_body_parameter

SolarCal body parameters that are assigned to this object.

property surface_temperatures

Data Collection of surface temperature values in degrees C.