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.8
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.8.tar.gz | 153.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ladybug_comfort-0.19.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 330.8 kB
Release files / ladybug_comfort-0.19.8.tar.gz
| Download URL | ladybug_comfort-0.19.8.tar.gz |
|---|---|
| Size | 153.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
68ea075b921f75edc30eb55f53d43ec0eb88a0a6b8220744f2f0e194e1376284
|
|
BLAKE2b-256 checksum How to use checksums |
4abda02ad831965a33f747099c151907da5a5058e670766502200ea5d01d2206
|
| 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.8-py3-none-any.whl
| Download URL | ladybug_comfort-0.19.8-py3-none-any.whl |
|---|---|
| Size | 177.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
127053bbcf48f5362dec5f107129a17b7768068008f186df8ba973cddba38dd4
|
|
BLAKE2b-256 checksum How to use checksums |
845d00d6e9586034625e607346bc2ff91dd10c8648c5f59ff9d4cbc51a4dc047
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
