ladybug_comfort.map.tcp module

Process comfort map results into thermal comfort percent.

ladybug_comfort.map.tcp.tcp_model_schedules(condition_csv, enclosure_info_json, occ_schedule_json, outdoor_occ_csv=None)[source]

Compute Thermal Comfort Percent (TCP) using model-exported occupancy schedules.

Parameters

  • condition_csv – Path to a CSV file of thermal conditions output by a thermal mapping command.

  • enclosure_info_json – Path to a JSON file containing information about the radiant enclosure that sensor points belong to. Note that this enclosure JSON should be for the same grid as the condition_csv.

  • occ_schedule_json – Path to an occupancy schedule JSON output by the honeybee-energy model-occ-schedules command.

  • outdoor_occ_csv – An optional path to a CSV file to specify the hours during which the outdoors is occupied. If None, it will be assumed that all hours on the outdoors are occupied. (Default: None).

Returns

A tuple fo three values

  • tcp_list – List of Thermal Comfort Percent (TCP) values for each sensor.

  • hsp_list – List of Heat Sensation Percent (HSP) values for each sensor.

  • csp_list - List of Cold Sensation Percent (CSP) values for each sensor.

ladybug_comfort.map.tcp.tcp_total(condition_csv, schedule=None)[source]

Compute Thermal Comfort Percent (TCP) assuming all times are occupied.

Parameters

  • condition_csv – Path to a CSV file of thermal conditions output by a thermal mapping command.

  • schedule – An optional path to a CSV file to specify the relevant times during which comfort should be evaluated. If None, it will be assumed that all hours are relevant. (Default: None).

Returns

A tuple fo three values.

  • tcp_list – List of Thermal Comfort Percent (TCP) values for each sensor.

  • hsp_list – List of Heat Sensation Percent (HSP) values for each sensor.

  • csp_list - List of Cold Sensation Percent (CSP) values for each sensor.