https://github.com/ladybug-tools/ladybug-comfort

🐞 :tired_face: :smile: :sweat: Ladybug extension for thermal comfort
https://github.com/ladybug-tools/ladybug-comfort

Last synced: 4 months ago
JSON representation

🐞 :tired_face: :smile: :sweat: Ladybug extension for thermal comfort

• Host: GitHub
• URL: https://github.com/ladybug-tools/ladybug-comfort
• Owner: ladybug-tools
• License: agpl-3.0
• Created: 2019-03-01T20:35:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2026-01-30T23:30:05.000Z (4 months ago)
• Last Synced: 2026-01-31T13:06:43.907Z (4 months ago)
• Language: Python
• Homepage: https://www.ladybug.tools/ladybug-comfort/docs/
• Size: 16.2 MB
• Stars: 17
• Watchers: 4
• Forks: 20
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          

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

[![Build Status](https://github.com/ladybug-tools/ladybug-comfort/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/ladybug-comfort/actions)

[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-comfort/badge.svg)](https://coveralls.io/github/ladybug-tools/ladybug-comfort)

[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![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-core](https://github.com/ladybug-tools/ladybug/).

## [API Documentation](https://www.ladybug.tools/ladybug-comfort/docs/)

## Installation

To install the library use:

`pip install ladybug-comfort`

If you want to also include the dependencies needed for thermal mapping use:

`pip install -U honeybee-energy[mapping]`

To check if the Ladybug-comfort command line interface is installed correctly,

use `ladybug-comfort --help`.

## Usage

```python

"""Get the percentage of time outdoor conditions are comfortable with/without sun + wind"""

from ladybug.epw import EPW

from ladybug_comfort.collection.utci import UTCI

epw_file_path = './tests/epw/chicago.epw'

epw = EPW(epw_file_path)

utci_obj_exposed = UTCI.from_epw(epw, include_wind=True, include_sun=True)

utci_obj_protected = UTCI.from_epw(epw, 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

```

## Local Development

1. Clone this repo locally

```console

git clone git@github.com:ladybug-tools/ladybug-comfort.git

# or

git clone https://github.com/ladybug-tools/ladybug-comfort.git

```

2. Install dependencies:

```console

cd ladybug-comfort

pip install -r dev-requirements.txt

pip install -r requirements.txt

```

3. Run Tests:

```console

python -m pytest ./tests

```

4. Generate Documentation:

```console

sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_comfort

sphinx-build -b html ./docs ./docs/_build/docs

```

### Derivative Work

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

* [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 these works can be found within the relevant .py files.