https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort
Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables.
https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort
Last synced: 4 days ago
JSON representation
Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables.
- Host: GitHub
- URL: https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort
- Owner: CenterForTheBuiltEnvironment
- License: mit
- Created: 2020-02-10T18:55:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-28T02:43:45.000Z (13 days ago)
- Last Synced: 2025-05-04T16:49:18.965Z (7 days ago)
- Language: Python
- Homepage: https://pythermalcomfort.readthedocs.io/en/latest/
- Size: 5.74 MB
- Stars: 170
- Watchers: 14
- Forks: 57
- Open Issues: 24
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.bib
- Authors: AUTHORS.rst
Awesome Lists containing this project
- open-sustainable-technology - pythermalcomfort - Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables. (Consumption / Buildings and Heating)
README
.. image:: https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/raw/development/docs/images/pythermalcomfort-3-short.png
:align: center
:alt: pythermalcomfort logo
================
pythermalcomfort
================
The ``pythermalcomfort`` Python package is a comprehensive toolkit for calculating **thermal comfort indices**, **heat/cold stress metrics**, and **thermophysiological responses** based on international standards and peer-reviewed research.
Designed for researchers, engineers, and building science professionals, it simplifies complex calculations while ensuring accuracy and compliance with industry standards.
Key Features
============
- **Thermal Comfort Calculations**:
Supports multiple models, including **PMV**, **PPD**, **adaptive comfort**, and **SET**.
- **Heat and Cold Stress Indices**:
Calculate **UTCI**, **Heat Index**, **Wind Chill Index**, and **Humidex** for assessing environmental stress.
- **Thermophysiological Models**:
Includes the **two-node (Gagge)** and **multinode (JOS-3)** models to estimate physiological responses like **core temperature**, **skin temperature**, and **skin wettedness**.
- **Standards Compliance**:
Implements calculations based on **ASHRAE 55**, **ISO 7730**, **EN 16798**, and more.
- **Ease of Use**:
Intuitive API for seamless integration into your projects.
- **Extensive Documentation**:
Detailed guides, examples, and tutorials to help you get started quickly.
- **Active Development**:
Regularly updated with new features, improvements, and bug fixes.
- **Open Source**:
Licensed under the MIT License for maximum flexibility and transparency.
Why Use pythermalcomfort?
=========================
- **Accurate Assessments**:
Reliable thermal comfort and stress evaluations for diverse environments.
- **Time-Saving**:
Automates complex calculations, saving you time and effort.
- **Versatility**:
Ideal for researchers, engineers, and professionals in **building science**, **HVAC design**, **environmental design**, **thermal physiology**, **sport science**, and **biometeorology**.
- **Enhanced Decision-Making**:
Empowers you to make data-driven decisions for **HVAC systems**, **building performance**, and **occupant comfort**.
Cite pythermalcomfort
=====================
If you use ``pythermalcomfort`` in your research, please cite it as follows:
.. code-block:: text
Tartarini, F., Schiavon, S., 2020.
pythermalcomfort: A Python package for thermal comfort research.
SoftwareX 12, 100578.
https://doi.org/10.1016/j.softx.2020.100578
Installation
============
Install ``pythermalcomfort`` via pip:
.. code-block:: bash
pip install pythermalcomfort
For advanced installation options, refer to the `Installation Instructions `_.
Quick Start
===========
Get started with ``pythermalcomfort`` in just a few lines of code:
.. code-block:: python
from pythermalcomfort.models import pmv_ppd_iso, utci
# Calculate PMV and PPD using ISO 7730 standard
result = pmv_ppd_iso(
tdb=25, # Dry Bulb Temperature in °C
tr=25, # Mean Radiant Temperature in °C
vr=0.1, # Relative air speed in m/s
rh=50, # Relative Humidity in %
met=1.4, # Metabolic rate in met
clo=0.5, # Clothing insulation in clo
model="7730-2005" # Year of the ISO standard
)
print(f"PMV: {result.pmv}, PPD: {result.ppd}")
# Calculate UTCI for heat stress assessment
utci_value = utci(tdb=30, tr=30, v=0.5, rh=50)
print(f"UTCI: {utci_value} °C")
For more examples and detailed usage, check out models and indices in the models section of the documentation.
Contribute
==========
We welcome contributions!
Whether you’re reporting a bug, suggesting a feature, or submitting a pull request, your input helps make ``pythermalcomfort`` better for everyone.
Check out our contribution page in the documentation to get started.
Documentation
=============
For detailed documentation, tutorials, and examples, visit our `Documentation `_.
License
=======
``pythermalcomfort`` is released under the MIT License.
=====
Stats
=====
.. start-badges
.. list-table::
:stub-columns: 1
* - Documentation
- |docs|
* - License
- |license|
* - Downloads
- |downloads|
* - Tests
- | |appveyor|
| |codecov|
| |tests|
* - Package
- | |version| |wheel|
| |supported-ver|
| |package-health|
.. |tests| image:: https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/actions/workflows/build-test-publish.yml/badge.svg
:target: https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/actions/workflows/build-test-publish.yml
:alt: Tests to ensure pythermalcomfort works on different Python versions and OS
.. |package-health| image:: https://snyk.io/advisor/python/pythermalcomfort/badge.svg
:target: https://snyk.io/advisor/python/pythermalcomfort
:alt: pythermalcomfort
.. |license| image:: https://img.shields.io/pypi/l/pythermalcomfort?color=brightgreen
:target: https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/blob/master/LICENSE
:alt: pythermalcomfort license
.. |docs| image:: https://readthedocs.org/projects/pythermalcomfort/badge/?style=flat
:target: https://readthedocs.org/projects/pythermalcomfort
:alt: Documentation Status
.. |downloads| image:: https://img.shields.io/pypi/dm/pythermalcomfort?color=brightgreen
:alt: PyPI - Downloads
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/CenterForTheBuiltEnvironment/pythermalcomfort?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/CenterForTheBuiltEnvironment/pythermalcomfort
.. |codecov| image:: https://codecov.io/github/CenterForTheBuiltEnvironment/pythermalcomfort/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/CenterForTheBuiltEnvironment/pythermalcomfort
.. |version| image:: https://img.shields.io/pypi/v/pythermalcomfort.svg
:alt: PyPI Package latest release
:target: https://pypi.org/project/pythermalcomfort
.. |wheel| image:: https://img.shields.io/pypi/wheel/pythermalcomfort.svg
:alt: PyPI Wheel
:target: https://pypi.org/project/pythermalcomfort
.. |supported-ver| image:: https://img.shields.io/pypi/pyversions/pythermalcomfort.svg
:alt: Supported versions
:target: https://pypi.org/project/pythermalcomfort
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pythermalcomfort.svg
:alt: Supported implementations
:target: https://pypi.org/project/pythermalcomfort
.. end-badges