Skip to main content

Ladybug comfort is a Python library that adds thermal comfort functionalities to Ladybug.

Project description

Ladybug

Build Status Coverage Status

Python 3.10 Python 3.7 Python 2.7 IronPython

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

  1. 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
  1. Install dependencies:
cd ladybug-comfort
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest ./tests
  1. 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:

Applicable copyright notices for these works can be found within the relevant .py files.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ladybug_comfort-0.18.86.tar.gz (151.8 kB view details)

Uploaded Source

Built Distribution

ladybug_comfort-0.18.86-py2.py3-none-any.whl (177.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ladybug_comfort-0.18.86.tar.gz.

File metadata

  • Download URL: ladybug_comfort-0.18.86.tar.gz
  • Upload date:
  • Size: 151.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.11

File hashes

Hashes for ladybug_comfort-0.18.86.tar.gz
Algorithm Hash digest
SHA256 6285fcd4bc557703d7bc2cf30ab2cbba838a078698b048679f0a184e400d4058
MD5 aed9dcb9d47c24981edcbdbd9b96daea
BLAKE2b-256 0ecf8b56d43fb6ffc5079834b3b51bef9bd51bec4adf47260c3aef4185207e03

See more details on using hashes here.

File details

Details for the file ladybug_comfort-0.18.86-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ladybug_comfort-0.18.86-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 84284dfe0fc0e3bd58b14a3f132d8874a7cae3943bfe83ffa4224b490ed4253a
MD5 d007fa830045c33d94d8c7c8ec630e8b
BLAKE2b-256 ec538718340916ed8911f73a0819cfa373b724e8902a4e6d481ee31626cbc992

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page