ladybug-comfort
Ladybug-comfort is a Python library that adds thermal comfort functionalities to ladybug-core.
API Documentation
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
"""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
- Clone this repo locally
git clone git@github.com:ladybug-tools/ladybug-comfort.git
# or
git clone https://github.com/ladybug-tools/ladybug-comfort.git
- Install dependencies:
cd ladybug-comfort
pip install -r dev-requirements.txt
pip install -r requirements.txt
- Run Tests:
python -m pytest ./tests
- Generate Documentation:
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 for indoor thermal comfort calculations. Available under GPL.
- UTCI Fortran Code for outdoor thermal comfort calculations. Available under MIT.
Applicable copyright notices for these works can be found within the relevant .py files.
1 maintainer
Release files for ladybug-comfort 0.19.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ladybug_comfort-0.19.9.tar.gz | 153.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ladybug_comfort-0.19.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 330.7 kB
Release files / ladybug_comfort-0.19.9.tar.gz
| Download URL | ladybug_comfort-0.19.9.tar.gz |
|---|---|
| Size | 153.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d8cb95c3d6de3f44394715f32c6b7d91a06487b11260a0738315e9f5495c79d7
|
|
BLAKE2b-256 checksum How to use checksums |
2b67c79d48bf86a712885d650a7ff7de75399f1e8628eafa0120c1d746698300
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
Release files / ladybug_comfort-0.19.9-py3-none-any.whl
| Download URL | ladybug_comfort-0.19.9-py3-none-any.whl |
|---|---|
| Size | 177.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bf79d63778716ab65bf53a43d77619ad416e8df8fe06f78bd0e48ef9033ae609
|
|
BLAKE2b-256 checksum How to use checksums |
e871b8c06a6978251c4e1c7d0a525870841ef8ad550172c42b73f99d4e89c402
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
