CLI Docs¶
Installation¶
To check if the command line is installed correctly use ladybug-comfort --help
AdaptiveChartAdaptiveChart.ToString()AdaptiveChart.data_mesh()AdaptiveChart.from_air_and_rad_temp()AdaptiveChart.plot_point()AdaptiveChart.to_y_value()AdaptiveChart.tp_x_value()AdaptiveChart.DT_TYPEAdaptiveChart.TEMP_TYPEAdaptiveChart.air_speedAdaptiveChart.base_pointAdaptiveChart.chart_borderAdaptiveChart.colored_meshAdaptiveChart.comfort_parameterAdaptiveChart.comfort_polygonAdaptiveChart.containerAdaptiveChart.data_pointsAdaptiveChart.degrees_from_neutralAdaptiveChart.hour_valuesAdaptiveChart.is_comfortableAdaptiveChart.legendAdaptiveChart.legend_parametersAdaptiveChart.max_operativeAdaptiveChart.max_prevailingAdaptiveChart.min_operativeAdaptiveChart.min_prevailingAdaptiveChart.neutral_polylineAdaptiveChart.neutral_temperatureAdaptiveChart.operative_label_pointsAdaptiveChart.operative_labelsAdaptiveChart.operative_linesAdaptiveChart.operative_temperatureAdaptiveChart.percent_coldAdaptiveChart.percent_comfortableAdaptiveChart.percent_hotAdaptiveChart.percent_neutralAdaptiveChart.percent_uncomfortableAdaptiveChart.prevailing_label_pointsAdaptiveChart.prevailing_labelsAdaptiveChart.prevailing_linesAdaptiveChart.prevailing_outdoor_temperatureAdaptiveChart.thermal_conditionAdaptiveChart.time_matrixAdaptiveChart.title_locationAdaptiveChart.title_textAdaptiveChart.use_ipAdaptiveChart.x_axis_locationAdaptiveChart.x_axis_textAdaptiveChart.x_dimAdaptiveChart.y_axis_locationAdaptiveChart.y_axis_textAdaptiveChart.y_dimPolygonPMVPolygonPMV.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_TYPEPolygonPMV.TEMP_TYPEPolygonPMV.air_speedPolygonPMV.clo_valuePolygonPMV.comfort_dataPolygonPMV.comfort_parameterPolygonPMV.comfort_polygonsPolygonPMV.comfort_valuesPolygonPMV.external_workPolygonPMV.is_comfort_too_coldPolygonPMV.is_comfort_too_hotPolygonPMV.left_comfort_linePolygonPMV.left_comfort_linesPolygonPMV.merged_comfort_dataPolygonPMV.merged_comfort_polygonPolygonPMV.merged_comfort_valuesPolygonPMV.met_ratePolygonPMV.polygon_countPolygonPMV.psychrometric_chartPolygonPMV.rad_temperaturePolygonPMV.right_comfort_linePolygonPMV.right_comfort_linesPolygonUTCIPolygonUTCI.ToString()PolygonUTCI.comfort_polylines()PolygonUTCI.create_collection()PolygonUTCI.evaluate_inside()PolygonUTCI.max_min_air_temperatures()PolygonUTCI.stress_polyline()PolygonUTCI.DELTA_TEMP_TYPEPolygonUTCI.POLYGON_INCLUSION_TYPEPolygonUTCI.TEMP_TYPEPolygonUTCI.comfort_dataPolygonUTCI.comfort_parameterPolygonUTCI.comfort_polygonsPolygonUTCI.comfort_valuesPolygonUTCI.is_comfort_too_coldPolygonUTCI.is_comfort_too_hotPolygonUTCI.left_comfort_linePolygonUTCI.left_comfort_linesPolygonUTCI.merged_comfort_dataPolygonUTCI.merged_comfort_polygonPolygonUTCI.merged_comfort_valuesPolygonUTCI.moderate_cold_polygonPolygonUTCI.moderate_heat_polygonPolygonUTCI.polygon_countPolygonUTCI.psychrometric_chartPolygonUTCI.rad_temperaturePolygonUTCI.right_comfort_linePolygonUTCI.right_comfort_linesPolygonUTCI.strong_cold_polygonPolygonUTCI.strong_heat_polygonPolygonUTCI.very_strong_cold_polygonPolygonUTCI.very_strong_heat_polygonPolygonUTCI.wind_speedAdaptiveAdaptive.ToString()Adaptive.from_air_and_rad_temp()Adaptive.air_speedAdaptive.calc_lengthAdaptive.comfort_modelAdaptive.comfort_parameterAdaptive.cooling_effectAdaptive.degrees_from_neutralAdaptive.is_comfortableAdaptive.neutral_temperatureAdaptive.operative_temperatureAdaptive.percent_coldAdaptive.percent_comfortableAdaptive.percent_hotAdaptive.percent_neutralAdaptive.percent_uncomfortableAdaptive.prevailing_outdoor_temperatureAdaptive.thermal_conditionPrevailingTemperaturePrevailingTemperature.get_aligned_prevailing()PrevailingTemperature.hourly_prevailing_temperature_timestep()PrevailingTemperature.avg_monthPrevailingTemperature.daily_prevailing_temperaturePrevailingTemperature.hourly_prevailing_temperaturePrevailingTemperature.monthly_per_hour_prevailing_temperaturePrevailingTemperature.monthly_prevailing_temperaturePETPET.ToString()PET.from_epw()PET.air_speedPET.air_temperaturePET.barometric_pressurePET.body_parameterPET.calc_lengthPET.clo_valuePET.clothing_temperaturePET.comfort_modelPET.core_body_temperaturePET.core_temperature_categoryPET.is_comfortablePET.met_ratePET.operative_temperaturePET.percent_coldPET.percent_comfortablePET.percent_hotPET.percent_neutralPET.percent_uncomfortablePET.pet_categoryPET.physiologic_equivalent_temperaturePET.rad_temperaturePET.rel_humidityPET.skin_temperaturePET.thermal_conditionPMVPMV.ToString()PMV.from_epw()PMV.adjusted_air_temperaturePMV.air_speedPMV.air_temperaturePMV.calc_lengthPMV.clo_valuePMV.comfort_modelPMV.comfort_parameterPMV.cooling_effectPMV.discomfort_reasonPMV.external_workPMV.heat_loss_conductionPMV.heat_loss_convectionPMV.heat_loss_dry_respirationPMV.heat_loss_latent_respirationPMV.heat_loss_radiationPMV.heat_loss_sweatingPMV.humidity_ratioPMV.is_comfortablePMV.met_ratePMV.operative_temperaturePMV.percent_coldPMV.percent_comfortablePMV.percent_dryPMV.percent_hotPMV.percent_humidPMV.percent_neutralPMV.percent_uncomfortablePMV.percentage_people_dissatisfiedPMV.predicted_mean_votePMV.rad_temperaturePMV.rel_humidityPMV.standard_effective_temperaturePMV.thermal_conditionHorizontalRefSolarCalHorizontalRefSolarCal.ToString()HorizontalRefSolarCal.calc_lengthHorizontalRefSolarCal.comfort_modelHorizontalRefSolarCal.diffuse_horizontal_solarHorizontalRefSolarCal.direct_horizontal_solarHorizontalRefSolarCal.effective_radiant_fieldHorizontalRefSolarCal.floor_reflectanceHorizontalRefSolarCal.fraction_body_exposedHorizontalRefSolarCal.locationHorizontalRefSolarCal.longwave_mrtHorizontalRefSolarCal.mean_radiant_temperatureHorizontalRefSolarCal.mrt_deltaHorizontalRefSolarCal.percent_coldHorizontalRefSolarCal.percent_hotHorizontalRefSolarCal.percent_neutralHorizontalRefSolarCal.reflected_horizontal_solarHorizontalRefSolarCal.solarcal_body_parameterHorizontalSolarCalHorizontalSolarCal.ToString()HorizontalSolarCal.calc_lengthHorizontalSolarCal.comfort_modelHorizontalSolarCal.diffuse_horizontal_solarHorizontalSolarCal.direct_horizontal_solarHorizontalSolarCal.effective_radiant_fieldHorizontalSolarCal.floor_reflectanceHorizontalSolarCal.fraction_body_exposedHorizontalSolarCal.locationHorizontalSolarCal.longwave_mrtHorizontalSolarCal.mean_radiant_temperatureHorizontalSolarCal.mrt_deltaHorizontalSolarCal.percent_coldHorizontalSolarCal.percent_hotHorizontalSolarCal.percent_neutralHorizontalSolarCal.solarcal_body_parameterIndoorSolarCalIndoorSolarCal.ToString()IndoorSolarCal.calc_lengthIndoorSolarCal.comfort_modelIndoorSolarCal.diffuse_horizontal_solarIndoorSolarCal.direct_normal_solarIndoorSolarCal.effective_radiant_fieldIndoorSolarCal.floor_reflectanceIndoorSolarCal.fraction_body_exposedIndoorSolarCal.locationIndoorSolarCal.longwave_mrtIndoorSolarCal.mean_radiant_temperatureIndoorSolarCal.mrt_deltaIndoorSolarCal.percent_coldIndoorSolarCal.percent_hotIndoorSolarCal.percent_neutralIndoorSolarCal.sky_exposureIndoorSolarCal.solarcal_body_parameterIndoorSolarCal.window_transmittanceOutdoorSolarCalOutdoorSolarCal.ToString()OutdoorSolarCal.calc_lengthOutdoorSolarCal.comfort_modelOutdoorSolarCal.diffuse_horizontal_solarOutdoorSolarCal.direct_normal_solarOutdoorSolarCal.floor_reflectanceOutdoorSolarCal.fraction_body_exposedOutdoorSolarCal.horizontal_infraredOutdoorSolarCal.locationOutdoorSolarCal.longwave_effective_radiant_fieldOutdoorSolarCal.longwave_mrt_deltaOutdoorSolarCal.mean_radiant_temperatureOutdoorSolarCal.mrt_deltaOutdoorSolarCal.percent_coldOutdoorSolarCal.percent_hotOutdoorSolarCal.percent_neutralOutdoorSolarCal.shortwave_effective_radiant_fieldOutdoorSolarCal.shortwave_mrt_deltaOutdoorSolarCal.sky_exposureOutdoorSolarCal.solarcal_body_parameterOutdoorSolarCal.surface_temperaturesUTCIUTCI.ToString()UTCI.from_epw()UTCI.air_temperatureUTCI.calc_lengthUTCI.comfort_modelUTCI.comfort_parameterUTCI.is_comfortableUTCI.original_utci_categoryUTCI.percent_coldUTCI.percent_comfortableUTCI.percent_extreme_cold_stressUTCI.percent_extreme_heat_stressUTCI.percent_hotUTCI.percent_moderate_cold_stressUTCI.percent_moderate_heat_stressUTCI.percent_neutralUTCI.percent_slight_cold_stressUTCI.percent_slight_heat_stressUTCI.percent_strong_cold_stressUTCI.percent_strong_heat_stressUTCI.percent_uncomfortableUTCI.percent_very_strong_cold_stressUTCI.percent_very_strong_heat_stressUTCI.rad_temperatureUTCI.rel_humidityUTCI.thermal_conditionUTCI.thermal_condition_eleven_pointUTCI.thermal_condition_five_pointUTCI.thermal_condition_nine_pointUTCI.thermal_condition_seven_pointUTCI.universal_thermal_climate_indexUTCI.wind_speedAdaptiveParameterAdaptiveParameter.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_methodAdaptiveParameter.ashrae_or_enAdaptiveParameter.avg_month_or_running_meanAdaptiveParameter.cold_prevail_temp_limitAdaptiveParameter.comfort_modelAdaptiveParameter.conditioningAdaptiveParameter.discrete_or_continuous_air_speedAdaptiveParameter.minimum_operativeAdaptiveParameter.neutral_offsetAdaptiveParameter.prevailing_temperature_methodAdaptiveParameter.standardPETParameterPETParameter.ToString()PETParameter.duplicate()PETParameter.from_dict()PETParameter.from_string()PETParameter.to_dict()PETParameter.POSTURESPETParameter.agePETParameter.body_massPETParameter.comfort_modelPETParameter.heightPETParameter.humid_acclimatedPETParameter.posturePETParameter.sexPMVParameterPMVParameter.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_modelPMVParameter.humid_ratio_lowerPMVParameter.humid_ratio_upperPMVParameter.ppd_comfort_threshPMVParameter.still_air_thresholdSolarCalParameterSolarCalParameter.ToString()SolarCalParameter.duplicate()SolarCalParameter.from_dict()SolarCalParameter.from_string()SolarCalParameter.get_sharp()SolarCalParameter.to_dict()SolarCalParameter.POSTURESSolarCalParameter.body_absorptivitySolarCalParameter.body_azimuthSolarCalParameter.body_emissivitySolarCalParameter.comfort_modelSolarCalParameter.postureSolarCalParameter.sharpUTCIParameterUTCIParameter.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_threshUTCIParameter.comfort_modelUTCIParameter.extreme_cold_threshUTCIParameter.extreme_heat_threshUTCIParameter.heat_threshUTCIParameter.moderate_cold_threshUTCIParameter.moderate_heat_threshUTCIParameter.strong_cold_threshUTCIParameter.strong_heat_threshUTCIParameter.very_strong_cold_threshUTCIParameter.very_strong_heat_threshadaptive_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()cooling_effect_en16798()en15251_neutral_offset_from_comfort_class()neutral_temperature_ashrae55()neutral_temperature_conditioned()neutral_temperature_conditioned_function()neutral_temperature_en15251()t_operative()weighted_running_mean_daily()weighted_running_mean_hourly()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()