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.6
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.6.tar.gz | 153.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ladybug_comfort-0.19.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 330.8 kB
Release files / ladybug_comfort-0.19.6.tar.gz
| Download URL | ladybug_comfort-0.19.6.tar.gz |
|---|---|
| Size | 153.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a2e07270fd9544e6c738e15072bf3a367940d1a107bbffb06f19702f5d99cc5c
|
|
BLAKE2b-256 checksum How to use checksums |
15ce10fee3ba98431aa2a299483e45aaddb328e2f40fae3c87626bff495e2561
|
| 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.6-py3-none-any.whl
| Download URL | ladybug_comfort-0.19.6-py3-none-any.whl |
|---|---|
| Size | 177.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d8f7c45696b23b9c0be47c718a4a38f3c9f62deb7a70088800de722bae7ae5f2
|
|
BLAKE2b-256 checksum How to use checksums |
205bdfc4ecebb81862ac4616407a5b2a57b343f3f9069dddfe0502cf73bba230
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.14
|
