Skip to main content

Ladybug comfort is a Python library that adds the functionalities for modeling thermal comfort to Ladybug.

Project description


![Ladybug](http://www.ladybug.tools/assets/img/ladybug.png)


[![Build Status](https://travis-ci.org/ladybug-tools/ladybug.svg?branch=master)](https://travis-ci.org/ladybug-tools/ladybug-comfort)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-comfort/badge.svg)](https://coveralls.io/github/ladybug-tools/ladybug-comfort)

[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# ladybug-comfort

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

## note
For the legacy Ladybug Grasshopper plugin see [this repository](https://github.com/mostaphaRoudsari/ladybug).

## API Documentation

## Installation

`pip install ladybug-comfort`


## Usage

```
"""Get the percentage of time outdoor conditions are comfortable with/without sun + wind"""
from ladybug.epw import EPW

relative_path = './tests/epw/chicago.epw'
epw = EPW(relative_path)
utci_obj_exposed = epw.get_universal_thermal_climate_index(
include_wind=True, include_sun=True)
utci_obj_protected = epw.get_universal_thermal_climate_index(
include_wind=False, include_sun=False)

print(utci_obj_exposed.percent_neutral) # comfortable percent of time with sun + wind
print(utci_obj_protected.percent_neutral) # comfortable percent of time without sun + wind
```


### derivative work
Ladybug-comfort is a derivative work of the following software projects:

[ladybug](https://github.com/ladybug). Available under GPL.
[CBE Comfort Tool](https://github.com/CenterForTheBuiltEnvironment/comfort_tool) for indoor thermal comfort calculations. Available under GPL.
[UTCI Fortran Code](http://www.utci.org/utci_doku.php) for outdoor thermal comfort calculations. Available under MIT.

Applicable copyright notices for theses works can be found within the relevant .py files.


Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ladybug-comfort-0.2.0.tar.gz (58.3 kB view hashes)

Uploaded Source

Built Distribution

ladybug_comfort-0.2.0-py2.py3-none-any.whl (85.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page