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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ladybug_comfort-0.19.5.tar.gz.
File metadata
- Download URL: ladybug_comfort-0.19.5.tar.gz
- Upload date:
- Size: 153.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
410eb817fae728bf72b0d531a4a0bc45fcb2ff521f4d111c478f04cd721edee6
|
|
| MD5 |
e4879e0d9cda74fd4f7fb5a4c04e81bd
|
|
| BLAKE2b-256 |
09d0c15cbfbe8b208dd5b279c3ab337c3afc8671c4e884bf9dfd9c6ba4e9c0e3
|
File details
Details for the file ladybug_comfort-0.19.5-py3-none-any.whl.
File metadata
- Download URL: ladybug_comfort-0.19.5-py3-none-any.whl
- Upload date:
- Size: 177.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96aada56b15b3c01e8006ff6e5ac3416619c91181a60d60027c579c1d996e963
|
|
| MD5 |
bb13439988007566c6b9529a9c641e0f
|
|
| BLAKE2b-256 |
bb124c4289a4fc822e7c65fef48a20b3d9fb39f30165d7e96a4cb4c210d5e569
|
