Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 4.01 KB

README.rst

File metadata and controls

116 lines (78 loc) · 4.01 KB
Raw

Overview

docs Documentation Status
license pythermalcomfort license
downloads PyPI - Downloads
tests
package

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

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 the code is pushed or pulled to the master repository 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.