.. image:: https://raw.githubusercontent.com/ecmwf-projects/thermofeel/master/thermofeel.png
:width: 600
:alt: thermofeel logo
|license| |tag_release| |docs|
**thermofeel** (pronounced *thermo-feel*)
A library to calculate human thermal comfort indexes.
Currently calculates the thermal indexes:
* Universal Thermal Climate Index
* Apparent Temperature
* Heat Index Adjusted
* Heat Index Simplified
* Humidex
* Normal Effective Temperature
* Wet Bulb Globe Temperature
* Wet Bulb Globe Temperature Simple
* Wind Chill
In support of the above indexes, it also calculates:
* Globe Temperature
* Mean Radiant Temperature
* Mean Radiant Temperature from Globe Temperature
* Relative Humidity Percentage
* Saturation vapour pressure
* Wet Bulb Temperature
PyPi
====
|pypi_status| |pypi_release| |pypi_downloads| |code_size|
Install with::
$ pip install thermofeel
Testing
=======
|ci| |codecov|
System dependencies
===================
thermofeel core functions depend on:
* numpy
* earthkit-meteo > 0.0.1 - for solar zenith angle calculation
Optionally, thermofeel depends on:
* pytest - for unit testing
Release notes
=============
Thermofeel 2.0 brings a number of changes to the underlying code but most importantly to the API.
Consequently, downstream packages using thermofeel 1.* will require code changes to migrate to version 2.0 and beyond.
The main changes are:
* standardisation of input and output variables
* standardisation of variable names
* removal of dependency on numba for code acceleration
* removal of solar zenith angle calculation (now provided by earthkit-meteo)
* several bug fixes and improvements
Please consult ChangeLog_ for more details.
.. _ChangeLog: https://github.com/ecmwf-projects/thermofeel/blob/master/ChangeLog.rst
Contributing
============
The main repository is hosted on `GitHub <https://github.com/ecmwf-projects/thermofeel>`_. Testing, bug reports and contributions are highly welcomed and appreciated.
Please see the Contributing_ document for the best way to help.
.. _Contributing: https://github.com/ecmwf-projects/thermofeel/blob/master/CONTRIBUTING.rst
Current developers:
- Claudia Di Napoli - `ECMWF <https://ecmwf.int>`_
- Tiago Quintino - `ECMWF <https://ecmwf.int>`_
See also the `contributors <https://github.com/ecmwf-projects/thermofeel/contributors>`_ for a more complete list.
License
=======
Copyright 2021 European Centre for Medium-Range Weather Forecasts (ECMWF)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
In applying this licence, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation nor
does it submit to any jurisdiction.
Citing
======
In publications, please use our paper in SoftwareX as the main citation for **thermofeel**:
Brimicombe, C., Di Napoli, C., Quintino, T., Pappenberger, F., Cornforth, R., & Cloke, H. L. (2022).
Thermofeel: A python thermal comfort indices library. SoftwareX, 18, 101005.
https://doi.org/10.1016/j.softx.2022.101005 `[cite] <https://github.com/ecmwf-projects/thermofeel/CITATION.bib>`_
To cite **thermofeel** the code currently please use:
Brimicombe, C., Di Napoli, C., Quintino, T., Pappenberger, F., Cornforth, R., & Cloke, H. L. (2021).
*thermofeel: a python thermal comfort indices library* https://doi.org/10.21957/mp6v-fd16
Acknowledgements
================
Past and current funding and support for **thermofeel** is listed in the adjoning Acknowledgements_
.. _Acknowledgements: https://github.com/ecmwf-projects/thermofeel/blob/master/ACKNOWLEDGEMENTS.rst
.. |last_commit| image:: https://img.shields.io/github/last-commit/ecmwf-projects/thermofeel
:target: https://github.com/ecmwf-projects/thermofeel
.. |commits_since_release| image:: https://img.shields.io/github/commits-since/ecmwf-projects/thermofeel/latest?sort=semver
:target: https://github.com/ecmwf-projects/thermofeel
.. |license| image:: https://img.shields.io/github/license/ecmwf-projects/thermofeel
:target: https://www.apache.org/licenses/LICENSE-2.0.html
.. |pypi_release| image:: https://img.shields.io/pypi/v/thermofeel?color=green
:target: https://pypi.org/project/thermofeel
.. |pypi_status| image:: https://img.shields.io/pypi/status/thermofeel
:target: https://pypi.org/project/thermofeel
.. |tag_release| image:: https://img.shields.io/github/v/release/ecmwf-projects/thermofeel?sort=semver
:target: https://github.com/ecmwf-projects/thermofeel
.. |codecov| image:: https://codecov.io/gh/ecmwf-projects/thermofeel/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ecmwf-projects/thermofeel
.. |ci| image:: https://img.shields.io/github/workflow/status/ecmwf-projects/thermofeel/ci
:target: https://github.com/ecmwf-projects/thermofeel/actions
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/thermofeel
:target: https://pypi.org/project/thermofeel
.. |code_size| image:: https://img.shields.io/github/languages/code-size/ecmwf-projects/thermofeel?color=green
:target: https://github.com/ecmwf-projects/thermofeel
.. |docs| image:: https://readthedocs.org/projects/thermofeel/badge/?version=latest
:target: https://thermofeel.readthedocs.io/en/latest/?badge=latest
Raw data
{
"_id": null,
"home_page": "https://github.com/ecmwf-projects/thermofeel",
"name": "thermofeel",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "tool",
"author": "European Centre for Medium-Range Weather Forecasts (ECMWF)",
"author_email": "software@ecmwf.int",
"download_url": "https://files.pythonhosted.org/packages/46/17/21ee0f46c604144a51c56fac37c33cb11cec9c7e68a3930a5691942c86ea/thermofeel-2.0.0.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/ecmwf-projects/thermofeel/master/thermofeel.png\n :width: 600\n :alt: thermofeel logo\n\n|license| |tag_release| |docs|\n\n**thermofeel** (pronounced *thermo-feel*)\n\nA library to calculate human thermal comfort indexes.\n\nCurrently calculates the thermal indexes:\n * Universal Thermal Climate Index\n * Apparent Temperature\n * Heat Index Adjusted\n * Heat Index Simplified\n * Humidex\n * Normal Effective Temperature\n * Wet Bulb Globe Temperature\n * Wet Bulb Globe Temperature Simple\n * Wind Chill\n\nIn support of the above indexes, it also calculates:\n * Globe Temperature\n * Mean Radiant Temperature\n * Mean Radiant Temperature from Globe Temperature\n * Relative Humidity Percentage\n * Saturation vapour pressure\n * Wet Bulb Temperature\n\nPyPi\n====\n\n|pypi_status| |pypi_release| |pypi_downloads| |code_size|\n\nInstall with::\n\n $ pip install thermofeel\n\nTesting\n=======\n\n|ci| |codecov|\n\nSystem dependencies\n===================\n\nthermofeel core functions depend on:\n * numpy\n * earthkit-meteo > 0.0.1 - for solar zenith angle calculation\n\nOptionally, thermofeel depends on:\n * pytest - for unit testing\n\n\nRelease notes\n=============\n\nThermofeel 2.0 brings a number of changes to the underlying code but most importantly to the API.\n\nConsequently, downstream packages using thermofeel 1.* will require code changes to migrate to version 2.0 and beyond.\n\nThe main changes are:\n * standardisation of input and output variables\n * standardisation of variable names\n * removal of dependency on numba for code acceleration\n * removal of solar zenith angle calculation (now provided by earthkit-meteo)\n * several bug fixes and improvements\n\nPlease consult ChangeLog_ for more details.\n\n.. _ChangeLog: https://github.com/ecmwf-projects/thermofeel/blob/master/ChangeLog.rst\n\n\nContributing\n============\n\nThe main repository is hosted on `GitHub <https://github.com/ecmwf-projects/thermofeel>`_. Testing, bug reports and contributions are highly welcomed and appreciated.\n\nPlease see the Contributing_ document for the best way to help.\n\n.. _Contributing: https://github.com/ecmwf-projects/thermofeel/blob/master/CONTRIBUTING.rst\n\nCurrent developers:\n\n- Claudia Di Napoli - `ECMWF <https://ecmwf.int>`_\n- Tiago Quintino - `ECMWF <https://ecmwf.int>`_\n\nSee also the `contributors <https://github.com/ecmwf-projects/thermofeel/contributors>`_ for a more complete list.\n\nLicense\n=======\n\nCopyright 2021 European Centre for Medium-Range Weather Forecasts (ECMWF)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\nIn applying this licence, ECMWF does not waive the privileges and immunities\ngranted to it by virtue of its status as an intergovernmental organisation nor\ndoes it submit to any jurisdiction.\n\nCiting\n======\n\n\nIn publications, please use our paper in SoftwareX as the main citation for **thermofeel**:\n\nBrimicombe, C., Di Napoli, C., Quintino, T., Pappenberger, F., Cornforth, R., & Cloke, H. L. (2022). \nThermofeel: A python thermal comfort indices library. SoftwareX, 18, 101005. \nhttps://doi.org/10.1016/j.softx.2022.101005 `[cite] <https://github.com/ecmwf-projects/thermofeel/CITATION.bib>`_\n\n\nTo cite **thermofeel** the code currently please use:\n\nBrimicombe, C., Di Napoli, C., Quintino, T., Pappenberger, F., Cornforth, R., & Cloke, H. L. (2021).\n*thermofeel: a python thermal comfort indices library* https://doi.org/10.21957/mp6v-fd16\n\n\nAcknowledgements\n================\nPast and current funding and support for **thermofeel** is listed in the adjoning Acknowledgements_\n\n\n.. _Acknowledgements: https://github.com/ecmwf-projects/thermofeel/blob/master/ACKNOWLEDGEMENTS.rst\n\n\n.. |last_commit| image:: https://img.shields.io/github/last-commit/ecmwf-projects/thermofeel\n :target: https://github.com/ecmwf-projects/thermofeel\n\n.. |commits_since_release| image:: https://img.shields.io/github/commits-since/ecmwf-projects/thermofeel/latest?sort=semver\n :target: https://github.com/ecmwf-projects/thermofeel\n\n.. |license| image:: https://img.shields.io/github/license/ecmwf-projects/thermofeel\n :target: https://www.apache.org/licenses/LICENSE-2.0.html\n\n.. |pypi_release| image:: https://img.shields.io/pypi/v/thermofeel?color=green\n :target: https://pypi.org/project/thermofeel\n\n.. |pypi_status| image:: https://img.shields.io/pypi/status/thermofeel\n :target: https://pypi.org/project/thermofeel\n\n.. |tag_release| image:: https://img.shields.io/github/v/release/ecmwf-projects/thermofeel?sort=semver\n :target: https://github.com/ecmwf-projects/thermofeel\n\n.. |codecov| image:: https://codecov.io/gh/ecmwf-projects/thermofeel/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/ecmwf-projects/thermofeel\n\n.. |ci| image:: https://img.shields.io/github/workflow/status/ecmwf-projects/thermofeel/ci\n :target: https://github.com/ecmwf-projects/thermofeel/actions\n\n.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/thermofeel\n :target: https://pypi.org/project/thermofeel\n\n.. |code_size| image:: https://img.shields.io/github/languages/code-size/ecmwf-projects/thermofeel?color=green\n :target: https://github.com/ecmwf-projects/thermofeel\n \n.. |docs| image:: https://readthedocs.org/projects/thermofeel/badge/?version=latest\n :target: https://thermofeel.readthedocs.io/en/latest/?badge=latest\n\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "A library to calculate human thermal comfort indexes",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/ecmwf-projects/thermofeel"
},
"split_keywords": [
"tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "461721ee0f46c604144a51c56fac37c33cb11cec9c7e68a3930a5691942c86ea",
"md5": "af81493b17b789f886588e39bd8a9845",
"sha256": "aee4e831e3c8ab91462f467dd8e937a8bf58d7f5c1c0312d7863be062bf25144"
},
"downloads": -1,
"filename": "thermofeel-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "af81493b17b789f886588e39bd8a9845",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22228,
"upload_time": "2023-11-24T14:54:48",
"upload_time_iso_8601": "2023-11-24T14:54:48.095742Z",
"url": "https://files.pythonhosted.org/packages/46/17/21ee0f46c604144a51c56fac37c33cb11cec9c7e68a3930a5691942c86ea/thermofeel-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 14:54:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ecmwf-projects",
"github_project": "thermofeel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "thermofeel"
}
JSON
