Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 2 months 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 (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-10-30T03:02:12.000Z (2 months ago)
Last Synced: 2024-11-12T23:46:48.999Z (about 2 months ago)
Language: Python
Homepage: https://pythermalcomfort.readthedocs.io/en/latest/
Size: 4.57 MB
Stars: 143
Watchers: 15
Forks: 52
Open Issues: 32
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

        ========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - docs

      - |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 make sure 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

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

.. _Examples: https://pythermalcomfort.readthedocs.io/en/latest/usage.html

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.

.. _here: https://pythermalcomfort.readthedocs.io/en/latest/contributing.html

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.