Skip to main content

Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables. Please cite us if you use this package: 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

Project description

Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables.

Please cite us if you use this package: 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

  • Free software: MIT license

Installation

pip install pythermalcomfort

You can also install the in-development version with:

pip install https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/archive/master.zip

Documentation

https://pythermalcomfort.readthedocs.io/

Examples and Tutorials

Examples files on how to use some of the functions

YouTube tutorials playlist

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Click here to learn more on how to contribute to the project.

Deployment

I am using travis to test the code. In addition, I have enabled GitHub actions. Every time a commit containing the message bump version is pushed to master then the GitHub action tests the code and if the tests pass, a new version of the package is published automatically on PyPI. See file in .github/workflows/ for more information.

Changelog

1.6.0 (2021-05-21)

  • (BREAKING CHANGE) moved some of the functions from psychrometrics to utilities

  • added equation to calculate body surface area

1.5.2 (2021-05-05)

  • return stress category UTCI

1.5.1 (2021-04-29)

  • optimized phs with Numba

1.5.0 (2021-04-21)

  • added Predicted Heat Strain (PHS) index from ISO 7933:2004

1.4.6 (2021-03-30)

  • changed equation to calculate convective heat transfer coefficient in set_tmp() as per Gagge’s 1986

  • fixed vasodilation coefficient in set_tmp()

  • docs changed term air velocity with air speed and improved documentation

  • added new tests for comfort functions

1.3.6 (2021-02-04)

  • fixed error calculation solar_altitude and sharp for supine person in solar_gain

1.3.5 (2021-02-02)

  • not rounding SET temperature when calculating cooling effect

1.3.3 (2020-12-14)

  • added function to calculate sky-vault view fraction

1.3.2 (2020-12-14)

  • replaced input solar_azimuth with sharp in the solar_gain() function

  • fixed small error in example pmv calculation

1.3.1 (2020-10-30)

  • Fixed error calculation of cooling effect with elevated air temperatures

1.3.0 (2020-10-19)

  • Changed PMV elevated air speed limit from 0.2 to 0.1 m/s

1.2.3 (2020-09-09)

  • Fixed error in the calculation of erf

  • Updated validation table erf

1.2.2 (2020-08-21)

  • Changed default diameter in t_mrt

  • Improved documentation

1.2.0 (2020-07-29)

  • Significantly improved calculation speed using numba. Wrapped set and pmv functions

1.0.6 (2020-07-24)

  • Minor speed improvement changed math.pow with **

  • Added validation PMV validation table from ISO 7730

1.0.4 (2020-07-20)

  • Improved speed calculation of the Cooling Effect

  • Bisection has been replaced with Brentq function from scipy

1.0.3 (2020-07-01)

  • Annotated variables in the SET code.

1.0.2 (2020-06-11)

  • Fixed an error in the bisection equation used to calculated Cooling Effect.

1.0.0 (2020-06-09)

  • Major stable release.

0.7.0 (2020-06-09)

  • Added equation to calculate the dynamic clothing insulation

0.6.3 (2020-04-11)

  • Fixed error in calculation adaptive ASHRAE

  • Added some examples

0.6.3 (2020-03-17)

  • Renamed function to_calc to t_o

  • Fixed error calculation of relative air speed

  • renamed input parameter ta to tdb

  • Added function to calculate mean radiant temperature from black globe temperature

  • Added function to calculate solar gain on people

  • Added functions to calculate vapour pressure, wet-bulb temperature, dew point temperature, and psychrometric data from dry bulb temperature and RH

  • Added authors

  • Added dictionaries with reference clo and met values

  • Added function to calculate enthalpy

0.5.2 (2020-03-11)

  • Added function to calculate the running mean outdoor temperature

0.5.1 (2020-03-06)

  • There was an error in version 0.4.2 in the calculation of PMV and PPD with elevated air speed, i.e. vr > 0.2 which has been fixed in this version

  • Added function to calculate the cooling effect in accordance with ASHRAE

0.4.1 (2020-02-17)

  • Removed compatibility with python 2.7 and 3.5

0.4.0 (2020-02-17)

  • Created adaptive_EN, v_relative, t_clo, vertical_tmp_gradient, ankle_draft functions and wrote tests.

  • Added possibility to decide with measuring system to use SI or IP.

0.3.0 (2020-02-13)

  • Created set_tmp, adaptive_ashrae, UTCI functions and wrote tests.

  • Added warning to let the user know if inputs entered do not comply with Standards applicability limits.

0.1.0 (2020-02-11)

  • Created pmv, pmv_ppd functions and wrote tests.

  • Documented code.

0.0.0 (2020-02-11)

  • First release on PyPI.

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

pythermalcomfort-1.6.0.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pythermalcomfort-1.6.0-py2.py3-none-any.whl (33.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pythermalcomfort-1.6.0.tar.gz.

File metadata

  • Download URL: pythermalcomfort-1.6.0.tar.gz
  • Upload date:
  • Size: 52.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10

File hashes

Hashes for pythermalcomfort-1.6.0.tar.gz
Algorithm Hash digest
SHA256 4b01efe08e33f888134812ac89f75d98811b9c8d6d8acb951506ea88a403b390
MD5 8a594f30744ede934c800a1ff0f1e962
BLAKE2b-256 0ceeee5309753c39483bb6ced8c7bdbb5c75a2e7f137bf82f60c0b30de9f72db

See more details on using hashes here.

File details

Details for the file pythermalcomfort-1.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pythermalcomfort-1.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10

File hashes

Hashes for pythermalcomfort-1.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 440699638e6c307356c0bc950f728240d8d358ca44afa9f676d511d73690659c
MD5 a1b4e2d941e1d9fb36ba0ef8e9ec9cab
BLAKE2b-256 b39f5050b7981dc2fbe787543ced8869b64df4f37f866ec046886b5f063b6064

See more details on using hashes here.

Supported by

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