Overview

| docs | | | :-----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | build | | | tests | | | page deployment | | | snyk security | | | license | | | npm version | |

Package to calculate thermophysiological, thermal comfort, thermal stress indices, in JavaScript.

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
• Authors: Federico Tartarini, Omar Jesus Acuache Briceno, Ruoshui Chen, Jingyu Lu, Yuchen Mu, Jordan Ocokoljic, Santiago Zaldivar del Alba​, Stefano Schiavon, Ollie Jay

Official Documentation Website

https://federicotartarini.github.io/jsthermalcomfort/

Installation

npm install jsthermalcomfort

If you want to use jsthermalcomfort package without installing it on your local machine, you can import with:

https://cdn.jsdelivr.net/npm/jsthermalcomfort/lib/esm/

Example:

import {
  models,
  utilities,
  psychrometrics,
} from "https://cdn.jsdelivr.net/npm/jsthermalcomfort/lib/esm/index.js";

You can also import it in the website directly, and caution that you need to mark the script as module:

<script type="module">
  import {
    models,
    utilities,
    psychrometrics,
  } from "https://cdn.jsdelivr.net/npm/jsthermalcomfort/lib/esm/index.js";
</script>

Examples and Tutorials

We developed a few examples files on how to use some of the functions.

Here is a list of examples running in the browser:

• PHS

Contributing

Contributions are welcome.

• Contributor guide: docs_theme/contributing.md
• Online docs version: Contributing
• Bug reports and feature requests: GitHub Issues

Local development (quick start)

npm ci
npm test
npm run check:format
npm run build

Validation datasets for model tests are fetched from FedericoTartarini/validation-data-comfort-models on GitHub (no submodule needed). By default tests use the main branch. To pin tests to a specific ref (tag/branch/commit), set VALIDATION_DATA_REF when running tests:

VALIDATION_DATA_REF=main npm test