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
Metadata
1 maintainer
Release files for ladybug-comfort 0.19.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ladybug_comfort-0.19.12.tar.gz | 153.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ladybug_comfort-0.19.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 330.8 kB
Release files / ladybug_comfort-0.19.12.tar.gz
| Download URL | ladybug_comfort-0.19.12.tar.gz |
|---|---|
| Size | 153.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0bacee1f382022714077e0afaa70efd9980e74e0c923969d14231251537b0c22
|
|
BLAKE2b-256 checksum How to use checksums |
474fb2ad5f2acbf37b826dacd0b920cad818c1b791cc20d6a871373a219f18f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.15
|
Release files / ladybug_comfort-0.19.12-py3-none-any.whl
| Download URL | ladybug_comfort-0.19.12-py3-none-any.whl |
|---|---|
| Size | 177.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c1584afe4327e9c57eeb7e00759b8d454e862e2f81eee109edc19c016bcc5b8
|
|
BLAKE2b-256 checksum How to use checksums |
f99ac1444083ce015f33424736aa0702c8a44c3238e592d8c64d15e9e8b42a51
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.15
|
Security for ladybug-comfort 0.19.12
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
