CLI Docs¶
Installation¶
To check if the command line is installed correctly use ladybug-comfort --help
AdaptiveChartToString()data_mesh()from_air_and_rad_temp()plot_point()to_y_value()tp_x_value()DT_TYPETEMP_TYPEair_speedbase_pointchart_bordercolored_meshcomfort_parametercomfort_polygoncontainerdata_pointsdegrees_from_neutralhour_valuesis_comfortablelegendlegend_parametersmax_operativemax_prevailingmin_operativemin_prevailingneutral_polylineneutral_temperatureoperative_label_pointsoperative_labelsoperative_linesoperative_temperaturepercent_coldpercent_comfortablepercent_hotpercent_neutralpercent_uncomfortableprevailing_label_pointsprevailing_labelsprevailing_linesprevailing_outdoor_temperaturethermal_conditiontime_matrixtitle_locationtitle_textuse_ipx_axis_locationx_axis_textx_dimy_axis_locationy_axis_texty_dimPolygonPMVToString()comfort_polylines()create_collection()evaluate_night_flush_polygon()evaluate_passive_solar()evaluate_polygon()evaporative_cooling_polygon()fan_use_polygon()internal_heat_polygon()max_min_air_temperatures()night_flush_polygon()passive_solar_polygon()shade_line()DELTA_TEMP_TYPETEMP_TYPEair_speedclo_valuecomfort_datacomfort_parametercomfort_polygonscomfort_valuesexternal_workis_comfort_too_coldis_comfort_too_hotleft_comfort_lineleft_comfort_linesmerged_comfort_datamerged_comfort_polygonmerged_comfort_valuesmet_ratepolygon_countpsychrometric_chartrad_temperatureright_comfort_lineright_comfort_linesPolygonUTCIToString()comfort_polylines()create_collection()evaluate_inside()max_min_air_temperatures()stress_polyline()DELTA_TEMP_TYPEPOLYGON_INCLUSION_TYPETEMP_TYPEcomfort_datacomfort_parametercomfort_polygonscomfort_valuesis_comfort_too_coldis_comfort_too_hotleft_comfort_lineleft_comfort_linesmerged_comfort_datamerged_comfort_polygonmerged_comfort_valuesmoderate_cold_polygonmoderate_heat_polygonpolygon_countpsychrometric_chartrad_temperatureright_comfort_lineright_comfort_linesstrong_cold_polygonstrong_heat_polygonvery_strong_cold_polygonvery_strong_heat_polygonwind_speedAdaptiveToString()from_air_and_rad_temp()air_speedcalc_lengthcomfort_modelcomfort_parametercooling_effectdegrees_from_neutralis_comfortableneutral_temperatureoperative_temperaturepercent_coldpercent_comfortablepercent_hotpercent_neutralpercent_uncomfortableprevailing_outdoor_temperaturethermal_conditionPrevailingTemperature
PETToString()from_epw()air_speedair_temperaturebarometric_pressurebody_parametercalc_lengthclo_valueclothing_temperaturecomfort_modelcore_body_temperaturecore_temperature_categoryis_comfortablemet_rateoperative_temperaturepercent_coldpercent_comfortablepercent_hotpercent_neutralpercent_uncomfortablepet_categoryphysiologic_equivalent_temperaturerad_temperaturerel_humidityskin_temperaturethermal_conditionPMVToString()from_epw()adjusted_air_temperatureair_speedair_temperaturecalc_lengthclo_valuecomfort_modelcomfort_parametercooling_effectdiscomfort_reasonexternal_workheat_loss_conductionheat_loss_convectionheat_loss_dry_respirationheat_loss_latent_respirationheat_loss_radiationheat_loss_sweatinghumidity_ratiois_comfortablemet_rateoperative_temperaturepercent_coldpercent_comfortablepercent_drypercent_hotpercent_humidpercent_neutralpercent_uncomfortablepercentage_people_dissatisfiedpredicted_mean_voterad_temperaturerel_humiditystandard_effective_temperaturethermal_conditionHorizontalRefSolarCal
HorizontalSolarCal
IndoorSolarCalToString()calc_lengthcomfort_modeldiffuse_horizontal_solardirect_normal_solareffective_radiant_fieldfloor_reflectancefraction_body_exposedlocationlongwave_mrtmean_radiant_temperaturemrt_deltapercent_coldpercent_hotpercent_neutralsky_exposuresolarcal_body_parameterwindow_transmittanceOutdoorSolarCalToString()calc_lengthcomfort_modeldiffuse_horizontal_solardirect_normal_solarfloor_reflectancefraction_body_exposedhorizontal_infraredlocationlongwave_effective_radiant_fieldlongwave_mrt_deltamean_radiant_temperaturemrt_deltapercent_coldpercent_hotpercent_neutralshortwave_effective_radiant_fieldshortwave_mrt_deltasky_exposuresolarcal_body_parametersurface_temperaturesUTCIToString()from_epw()air_temperaturecalc_lengthcomfort_modelcomfort_parameteris_comfortableoriginal_utci_categorypercent_coldpercent_comfortablepercent_extreme_cold_stresspercent_extreme_heat_stresspercent_hotpercent_moderate_cold_stresspercent_moderate_heat_stresspercent_neutralpercent_slight_cold_stresspercent_slight_heat_stresspercent_strong_cold_stresspercent_strong_heat_stresspercent_uncomfortablepercent_very_strong_cold_stresspercent_very_strong_heat_stressrad_temperaturerel_humiditythermal_conditionthermal_condition_eleven_pointthermal_condition_five_pointthermal_condition_nine_pointthermal_condition_seven_pointuniversal_thermal_climate_indexwind_speedAdaptiveParameterToString()duplicate()from_dict()from_string()is_comfortable()set_neutral_offset_from_comfort_class()set_neutral_offset_from_ppd()thermal_condition()to_dict()air_speed_methodashrae_or_enavg_month_or_running_meancold_prevail_temp_limitcomfort_modelconditioningdiscrete_or_continuous_air_speedminimum_operativeneutral_offsetprevailing_temperature_methodstandardUTCIParameterToString()duplicate()from_dict()from_string()is_comfortable()original_utci_category()thermal_condition()thermal_condition_eleven_point()thermal_condition_five_point()thermal_condition_nine_point()thermal_condition_seven_point()to_dict()cold_threshcomfort_modelextreme_cold_threshextreme_heat_threshheat_threshmoderate_cold_threshmoderate_heat_threshstrong_cold_threshstrong_heat_threshvery_strong_cold_threshvery_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()