ladybug comfort
  • Site
      • CLI Docs
        • Installation
        • Commands
          • map
            • ladybug-comfort map
              • adaptive
              • air
              • irradiance-contrib
              • longwave-mrt
              • map-result-info
              • pmv
              • shortwave-mrt
              • tcp
              • utci
          • sql
            • ladybug-comfort sql
              • adaptive-by-room
              • pmv-by-room
          • mtx
            • ladybug-comfort mtx
              • adaptive
              • pmv
              • utci
          • epw
            • ladybug-comfort epw
              • air-speed-json
              • prevailing
              • set
              • utci
      • ladybug_comfort
        • ladybug_comfort package
          • Subpackages
            • ladybug_comfort.chart package
              • Submodules
                • ladybug_comfort.chart.polygonpmv module
                  • PolygonPMV
                    • PolygonPMV.ToString()
                    • PolygonPMV.comfort_polylines()
                    • PolygonPMV.create_collection()
                    • PolygonPMV.evaluate_night_flush_polygon()
                    • PolygonPMV.evaluate_passive_solar()
                    • PolygonPMV.evaluate_polygon()
                    • PolygonPMV.evaporative_cooling_polygon()
                    • PolygonPMV.fan_use_polygon()
                    • PolygonPMV.internal_heat_polygon()
                    • PolygonPMV.max_min_air_temperatures()
                    • PolygonPMV.night_flush_polygon()
                    • PolygonPMV.passive_solar_polygon()
                    • PolygonPMV.shade_line()
                    • PolygonPMV.DELTA_TEMP_TYPE
                    • PolygonPMV.TEMP_TYPE
                    • PolygonPMV.air_speed
                    • PolygonPMV.clo_value
                    • PolygonPMV.comfort_data
                    • PolygonPMV.comfort_parameter
                    • PolygonPMV.comfort_polygons
                    • PolygonPMV.comfort_values
                    • PolygonPMV.external_work
                    • PolygonPMV.is_comfort_too_cold
                    • PolygonPMV.is_comfort_too_hot
                    • PolygonPMV.left_comfort_line
                    • PolygonPMV.left_comfort_lines
                    • PolygonPMV.merged_comfort_data
                    • PolygonPMV.merged_comfort_polygon
                    • PolygonPMV.merged_comfort_values
                    • PolygonPMV.met_rate
                    • PolygonPMV.polygon_count
                    • PolygonPMV.psychrometric_chart
                    • PolygonPMV.rad_temperature
                    • PolygonPMV.right_comfort_line
                    • PolygonPMV.right_comfort_lines
              • Module contents
            • ladybug_comfort.cli package
              • Submodules
                • ladybug_comfort.cli.epw module
                • ladybug_comfort.cli.map module
                • ladybug_comfort.cli.mtx module
                • ladybug_comfort.cli.sql module
              • Module contents
            • ladybug_comfort.collection package
              • Submodules
                • ladybug_comfort.collection.adaptive module
                  • Adaptive
                    • Adaptive.ToString()
                    • Adaptive.from_air_and_rad_temp()
                    • Adaptive.air_speed
                    • Adaptive.calc_length
                    • Adaptive.comfort_model
                    • Adaptive.comfort_parameter
                    • Adaptive.cooling_effect
                    • Adaptive.degrees_from_neutral
                    • Adaptive.is_comfortable
                    • Adaptive.neutral_temperature
                    • Adaptive.operative_temperature
                    • Adaptive.percent_cold
                    • Adaptive.percent_comfortable
                    • Adaptive.percent_hot
                    • Adaptive.percent_neutral
                    • Adaptive.percent_uncomfortable
                    • Adaptive.prevailing_outdoor_temperature
                    • Adaptive.thermal_condition
                  • PrevailingTemperature
                    • PrevailingTemperature.get_aligned_prevailing()
                    • PrevailingTemperature.hourly_prevailing_temperature_timestep()
                    • PrevailingTemperature.avg_month
                    • PrevailingTemperature.daily_prevailing_temperature
                    • PrevailingTemperature.hourly_prevailing_temperature
                    • PrevailingTemperature.monthly_per_hour_prevailing_temperature
                    • PrevailingTemperature.monthly_prevailing_temperature
                • ladybug_comfort.collection.base module
                  • ComfortCollection
                    • ComfortCollection.ToString()
                    • ComfortCollection.calc_length
                    • ComfortCollection.comfort_model
                    • ComfortCollection.percent_cold
                    • ComfortCollection.percent_hot
                    • ComfortCollection.percent_neutral
                • ladybug_comfort.collection.pet module
                  • PET
                    • PET.ToString()
                    • PET.from_epw()
                    • PET.air_speed
                    • PET.air_temperature
                    • PET.barometric_pressure
                    • PET.body_parameter
                    • PET.calc_length
                    • PET.clo_value
                    • PET.clothing_temperature
                    • PET.comfort_model
                    • PET.core_body_temperature
                    • PET.core_temperature_category
                    • PET.is_comfortable
                    • PET.met_rate
                    • PET.operative_temperature
                    • PET.percent_cold
                    • PET.percent_comfortable
                    • PET.percent_hot
                    • PET.percent_neutral
                    • PET.percent_uncomfortable
                    • PET.pet_category
                    • PET.physiologic_equivalent_temperature
                    • PET.rad_temperature
                    • PET.rel_humidity
                    • PET.skin_temperature
                    • PET.thermal_condition
                • ladybug_comfort.collection.pmv module
                  • PMV
                    • PMV.ToString()
                    • PMV.from_epw()
                    • PMV.adjusted_air_temperature
                    • PMV.air_speed
                    • PMV.air_temperature
                    • PMV.calc_length
                    • PMV.clo_value
                    • PMV.comfort_model
                    • PMV.comfort_parameter
                    • PMV.cooling_effect
                    • PMV.discomfort_reason
                    • PMV.external_work
                    • PMV.heat_loss_conduction
                    • PMV.heat_loss_convection
                    • PMV.heat_loss_dry_respiration
                    • PMV.heat_loss_latent_respiration
                    • PMV.heat_loss_radiation
                    • PMV.heat_loss_sweating
                    • PMV.humidity_ratio
                    • PMV.is_comfortable
                    • PMV.met_rate
                    • PMV.operative_temperature
                    • PMV.percent_cold
                    • PMV.percent_comfortable
                    • PMV.percent_dry
                    • PMV.percent_hot
                    • PMV.percent_humid
                    • PMV.percent_neutral
                    • PMV.percent_uncomfortable
                    • PMV.percentage_people_dissatisfied
                    • PMV.predicted_mean_vote
                    • PMV.rad_temperature
                    • PMV.rel_humidity
                    • PMV.standard_effective_temperature
                    • PMV.thermal_condition
                • ladybug_comfort.collection.solarcal module
                  • HorizontalRefSolarCal
                    • HorizontalRefSolarCal.ToString()
                    • HorizontalRefSolarCal.calc_length
                    • HorizontalRefSolarCal.comfort_model
                    • HorizontalRefSolarCal.diffuse_horizontal_solar
                    • HorizontalRefSolarCal.direct_horizontal_solar
                    • HorizontalRefSolarCal.effective_radiant_field
                    • HorizontalRefSolarCal.floor_reflectance
                    • HorizontalRefSolarCal.fraction_body_exposed
                    • HorizontalRefSolarCal.location
                    • HorizontalRefSolarCal.longwave_mrt
                    • HorizontalRefSolarCal.mean_radiant_temperature
                    • HorizontalRefSolarCal.mrt_delta
                    • HorizontalRefSolarCal.percent_cold
                    • HorizontalRefSolarCal.percent_hot
                    • HorizontalRefSolarCal.percent_neutral
                    • HorizontalRefSolarCal.reflected_horizontal_solar
                    • HorizontalRefSolarCal.solarcal_body_parameter
                  • HorizontalSolarCal
                    • HorizontalSolarCal.ToString()
                    • HorizontalSolarCal.calc_length
                    • HorizontalSolarCal.comfort_model
                    • HorizontalSolarCal.diffuse_horizontal_solar
                    • HorizontalSolarCal.direct_horizontal_solar
                    • HorizontalSolarCal.effective_radiant_field
                    • HorizontalSolarCal.floor_reflectance
                    • HorizontalSolarCal.fraction_body_exposed
                    • HorizontalSolarCal.location
                    • HorizontalSolarCal.longwave_mrt
                    • HorizontalSolarCal.mean_radiant_temperature
                    • HorizontalSolarCal.mrt_delta
                    • HorizontalSolarCal.percent_cold
                    • HorizontalSolarCal.percent_hot
                    • HorizontalSolarCal.percent_neutral
                    • HorizontalSolarCal.solarcal_body_parameter
                  • IndoorSolarCal
                    • IndoorSolarCal.ToString()
                    • IndoorSolarCal.calc_length
                    • IndoorSolarCal.comfort_model
                    • IndoorSolarCal.diffuse_horizontal_solar
                    • IndoorSolarCal.direct_normal_solar
                    • IndoorSolarCal.effective_radiant_field
                    • IndoorSolarCal.floor_reflectance
                    • IndoorSolarCal.fraction_body_exposed
                    • IndoorSolarCal.location
                    • IndoorSolarCal.longwave_mrt
                    • IndoorSolarCal.mean_radiant_temperature
                    • IndoorSolarCal.mrt_delta
                    • IndoorSolarCal.percent_cold
                    • IndoorSolarCal.percent_hot
                    • IndoorSolarCal.percent_neutral
                    • IndoorSolarCal.sky_exposure
                    • IndoorSolarCal.solarcal_body_parameter
                    • IndoorSolarCal.window_transmittance
                  • OutdoorSolarCal
                    • OutdoorSolarCal.ToString()
                    • OutdoorSolarCal.calc_length
                    • OutdoorSolarCal.comfort_model
                    • OutdoorSolarCal.diffuse_horizontal_solar
                    • OutdoorSolarCal.direct_normal_solar
                    • OutdoorSolarCal.floor_reflectance
                    • OutdoorSolarCal.fraction_body_exposed
                    • OutdoorSolarCal.horizontal_infrared
                    • OutdoorSolarCal.location
                    • OutdoorSolarCal.longwave_effective_radiant_field
                    • OutdoorSolarCal.longwave_mrt_delta
                    • OutdoorSolarCal.mean_radiant_temperature
                    • OutdoorSolarCal.mrt_delta
                    • OutdoorSolarCal.percent_cold
                    • OutdoorSolarCal.percent_hot
                    • OutdoorSolarCal.percent_neutral
                    • OutdoorSolarCal.shortwave_effective_radiant_field
                    • OutdoorSolarCal.shortwave_mrt_delta
                    • OutdoorSolarCal.sky_exposure
                    • OutdoorSolarCal.solarcal_body_parameter
                    • OutdoorSolarCal.surface_temperatures
                • ladybug_comfort.collection.utci module
                  • UTCI
                    • UTCI.ToString()
                    • UTCI.from_epw()
                    • UTCI.air_temperature
                    • UTCI.calc_length
                    • UTCI.comfort_model
                    • UTCI.comfort_parameter
                    • UTCI.is_comfortable
                    • UTCI.original_utci_category
                    • UTCI.percent_cold
                    • UTCI.percent_comfortable
                    • UTCI.percent_extreme_cold_stress
                    • UTCI.percent_extreme_heat_stress
                    • UTCI.percent_hot
                    • UTCI.percent_moderate_cold_stress
                    • UTCI.percent_moderate_heat_stress
                    • UTCI.percent_neutral
                    • UTCI.percent_slight_cold_stress
                    • UTCI.percent_slight_heat_stress
                    • UTCI.percent_strong_cold_stress
                    • UTCI.percent_strong_heat_stress
                    • UTCI.percent_uncomfortable
                    • UTCI.percent_very_strong_cold_stress
                    • UTCI.percent_very_strong_heat_stress
                    • UTCI.rad_temperature
                    • UTCI.rel_humidity
                    • UTCI.thermal_condition
                    • UTCI.thermal_condition_eleven_point
                    • UTCI.thermal_condition_five_point
                    • UTCI.thermal_condition_nine_point
                    • UTCI.thermal_condition_seven_point
                    • UTCI.universal_thermal_climate_index
                    • UTCI.wind_speed
              • Module contents
            • ladybug_comfort.map package
              • Submodules
                • ladybug_comfort.map.air module
                  • air_map()
                • ladybug_comfort.map.irr module
                  • irradiance_contrib_map()
                • ladybug_comfort.map.mrt module
                  • longwave_mrt_map()
                  • shortwave_mrt_map()
                • ladybug_comfort.map.tcp module
                  • tcp_model_schedules()
                  • tcp_total()
              • Module contents
            • ladybug_comfort.parameter package
              • Submodules
                • ladybug_comfort.parameter.adaptive module
                  • AdaptiveParameter
                    • AdaptiveParameter.ToString()
                    • AdaptiveParameter.duplicate()
                    • AdaptiveParameter.from_dict()
                    • AdaptiveParameter.from_string()
                    • AdaptiveParameter.is_comfortable()
                    • AdaptiveParameter.set_neutral_offset_from_comfort_class()
                    • AdaptiveParameter.set_neutral_offset_from_ppd()
                    • AdaptiveParameter.thermal_condition()
                    • AdaptiveParameter.to_dict()
                    • AdaptiveParameter.air_speed_method
                    • AdaptiveParameter.ashrae55_or_en15251
                    • AdaptiveParameter.avg_month_or_running_mean
                    • AdaptiveParameter.cold_prevail_temp_limit
                    • AdaptiveParameter.comfort_model
                    • AdaptiveParameter.conditioning
                    • AdaptiveParameter.discrete_or_continuous_air_speed
                    • AdaptiveParameter.minimum_operative
                    • AdaptiveParameter.neutral_offset
                    • AdaptiveParameter.prevailing_temperature_method
                    • AdaptiveParameter.standard
                • ladybug_comfort.parameter.pet module
                  • PETParameter
                    • PETParameter.ToString()
                    • PETParameter.duplicate()
                    • PETParameter.from_dict()
                    • PETParameter.from_string()
                    • PETParameter.to_dict()
                    • PETParameter.POSTURES
                    • PETParameter.age
                    • PETParameter.body_mass
                    • PETParameter.comfort_model
                    • PETParameter.height
                    • PETParameter.humid_acclimated
                    • PETParameter.posture
                    • PETParameter.sex
                • ladybug_comfort.parameter.pmv module
                  • PMVParameter
                    • PMVParameter.ToString()
                    • PMVParameter.discomfort_reason()
                    • PMVParameter.duplicate()
                    • PMVParameter.from_dict()
                    • PMVParameter.from_string()
                    • PMVParameter.is_comfortable()
                    • PMVParameter.set_ppd_comfort_thresh_from_comfort_class()
                    • PMVParameter.thermal_condition()
                    • PMVParameter.to_dict()
                    • PMVParameter.comfort_model
                    • PMVParameter.humid_ratio_lower
                    • PMVParameter.humid_ratio_upper
                    • PMVParameter.ppd_comfort_thresh
                    • PMVParameter.still_air_threshold
                • ladybug_comfort.parameter.solarcal module
                  • SolarCalParameter
                    • SolarCalParameter.ToString()
                    • SolarCalParameter.duplicate()
                    • SolarCalParameter.from_dict()
                    • SolarCalParameter.from_string()
                    • SolarCalParameter.get_sharp()
                    • SolarCalParameter.to_dict()
                    • SolarCalParameter.POSTURES
                    • SolarCalParameter.body_absorptivity
                    • SolarCalParameter.body_azimuth
                    • SolarCalParameter.body_emissivity
                    • SolarCalParameter.comfort_model
                    • SolarCalParameter.posture
                    • SolarCalParameter.sharp
                • ladybug_comfort.parameter.utci module
                  • UTCIParameter
                    • UTCIParameter.ToString()
                    • UTCIParameter.duplicate()
                    • UTCIParameter.from_dict()
                    • UTCIParameter.from_string()
                    • UTCIParameter.is_comfortable()
                    • UTCIParameter.original_utci_category()
                    • UTCIParameter.thermal_condition()
                    • UTCIParameter.thermal_condition_eleven_point()
                    • UTCIParameter.thermal_condition_five_point()
                    • UTCIParameter.thermal_condition_nine_point()
                    • UTCIParameter.thermal_condition_seven_point()
                    • UTCIParameter.to_dict()
                    • UTCIParameter.cold_thresh
                    • UTCIParameter.comfort_model
                    • UTCIParameter.extreme_cold_thresh
                    • UTCIParameter.extreme_heat_thresh
                    • UTCIParameter.heat_thresh
                    • UTCIParameter.moderate_cold_thresh
                    • UTCIParameter.moderate_heat_thresh
                    • UTCIParameter.strong_cold_thresh
                    • UTCIParameter.strong_heat_thresh
                    • UTCIParameter.very_strong_cold_thresh
                    • UTCIParameter.very_strong_heat_thresh
              • Module contents
          • Submodules
            • ladybug_comfort.adaptive module
              • adaptive_comfort_ashrae55()
              • adaptive_comfort_conditioned()
              • adaptive_comfort_conditioned_function()
              • adaptive_comfort_en15251()
              • ashrae55_neutral_offset_from_ppd()
              • check_prevailing_temperatures_ashrae55()
              • check_prevailing_temperatures_en15251()
              • check_prevailing_temperatures_range()
              • cooling_effect_ashrae55()
              • cooling_effect_en15251()
              • en15251_neutral_offset_from_comfort_class()
              • neutral_temperature_ashrae55()
              • neutral_temperature_conditioned()
              • neutral_temperature_en15251()
              • t_operative()
              • weighted_running_mean_daily()
              • weighted_running_mean_hourly()
            • ladybug_comfort.asv module
              • actual_sensation_vote()
              • actual_sensation_vote_effect_category()
            • ladybug_comfort.at module
              • apparent_temperature()
              • apparent_temperature_warning_category()
            • ladybug_comfort.clo module
              • schiavon_clo()
            • ladybug_comfort.degreetime module
              • cooling_degree_time()
              • heating_degree_time()
            • ladybug_comfort.di module
              • discomfort_index()
              • discomfort_index_effect_category()
            • ladybug_comfort.hi module
              • heat_index()
              • heat_index_warning_category()
            • ladybug_comfort.humidex module
              • humidex()
              • humidex_degree_of_comfort()
            • ladybug_comfort.pet module
              • core_temperature_category()
              • memi_balance()
              • pet_category()
              • pet_category_humid()
              • physiologic_equivalent_temperature()
              • sweat_volume()
              • vaso_circulation()
            • ladybug_comfort.pmv module
              • calc_missing_pmv_input()
              • fanger_pmv()
              • pierce_set()
              • pmv_from_ppd()
              • ppd_from_pmv()
              • ppd_threshold_from_comfort_class()
              • predicted_mean_vote()
              • predicted_mean_vote_no_set()
              • saturated_vapor_pressure_torr()
            • ladybug_comfort.solarcal module
              • body_diff_from_diff_horiz()
              • body_dir_from_dir_horiz()
              • body_dir_from_dir_normal()
              • body_ref_from_glob_horiz()
              • body_ref_from_ref_horiz()
              • body_solar_flux_from_horiz_components()
              • body_solar_flux_from_horiz_solar()
              • body_solar_flux_from_parts()
              • erf_from_body_solar_flux()
              • erf_from_mrt_delta()
              • get_projection_factor()
              • get_projection_factor_simple()
              • indoor_sky_heat_exch()
              • longwave_mrt_delta_from_horiz_ir()
              • longwave_mrt_delta_from_sky_temp()
              • mrt_delta_from_erf()
              • outdoor_sky_heat_exch()
              • sharp_from_solar_and_body_azimuth()
              • shortwave_from_horiz_components()
              • shortwave_from_horiz_solar()
              • transpose_altitude_azimuth()
            • ladybug_comfort.ts module
              • thermal_sensation()
              • thermal_sensation_effect_category()
            • ladybug_comfort.utci module
              • calc_missing_utci_input()
              • saturated_vapor_pressure_hpa()
              • universal_thermal_climate_index()
            • ladybug_comfort.wbgt module
              • wbgt_warning_category()
              • wet_bulb_globe_temperature()
            • ladybug_comfort.wc module
              • windchill_index()
              • windchill_index_effect_category()
              • windchill_temp()
              • windchill_temp_effect_category()
          • Module contents
  • Page
      • CLI Docs
      • ladybug_comfort
  • CLI Docs »
  • Source
  • CLI Docs
  • ladybug_comfort

Welcome to Ladybug Comfort’s documentation!¶

http://www.ladybug.tools/assets/img/ladybug.png

Ladybug-comfort is a Python library that adds thermal comfort functionalities to ladybug-core.

Installation¶

pip install -U ladybug-comfort

CLI Docs¶

For command line interface documentation and API documentation see the pages below.

  • CLI Docs
    • Installation
    • Commands

ladybug_comfort¶

  • ladybug_comfort
    • ladybug_comfort package
      • Subpackages
        • ladybug_comfort.chart package
        • ladybug_comfort.cli package
        • ladybug_comfort.collection package
        • ladybug_comfort.map package
        • ladybug_comfort.parameter package
      • Submodules
        • ladybug_comfort.adaptive module
        • ladybug_comfort.asv module
        • ladybug_comfort.at module
        • ladybug_comfort.clo module
        • ladybug_comfort.degreetime module
        • ladybug_comfort.di module
        • ladybug_comfort.hi module
        • ladybug_comfort.humidex module
        • ladybug_comfort.pet module
        • ladybug_comfort.pmv module
        • ladybug_comfort.solarcal module
        • ladybug_comfort.ts module
        • ladybug_comfort.utci module
        • ladybug_comfort.wbgt module
        • ladybug_comfort.wc module
      • Module contents

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Back to top

© Copyright 2023, Ladybug Tools.
Created using Sphinx 5.3.0.