Here is a list of examples running in the browser:
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+When reporting a bug please include:
+jsthermalcomfort could always use more documentation, whether as part of the official jsthermalcomfort docs, in JSDocs, or even on the web in blog posts, articles, and such.
+The best way to send feedback is to file an issue at https://github.com/FedericoTartarini/jsthermalcomfort/issues
+If you are proposing a feature:
+To set up jsthermalcomfort for local development:
+Fork jsthermalcomfort (look for the “Fork” button).
+Clone your fork locally. Fetch and pull all the updates from the master branch before you do anything:
+git clone git@github.com:FedericoTartarini/jsthermalcomfort.git
+Create a branch for local development. The naming rule for new branch are, as follows:
+You can create a branch locally using the following command. Make sure you only push updates to this new branch only:
+git checkout -b name-of-your-bugfix-or-feature+
Now you can make your changes locally.
+When you’re done making changes run all tests using Jest:
+npm run test
+npm run format+
git add .
+git commit -m "Your detailed description of your changes."
+npm run docs+
git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature+
Submit a pull request after you have done all your modifications and tested your work. The pull request should include a detailed description of your work:
+If you need some code review or feedback while you’re developing the code just make the pull request.
+For merging, you should:
+npm run test).We are using JSDoc and documentation.js to automatically build the documentation.
+src/models/ with the name of the function/model and document it.src/utilities/utilities.js or src/psychrometrics/. See existing code as example.
+@public, add it to its corresponding category, for example for models you should do @memberof models, and lastly you should give it a proper name for the documentation with @docname, for example: @docname Clothing prediction. It is important to note that you should also add the @public tag to any types the function exposes/uses.tests/models/<name_of_model>.test.js.To run a subset of tests you can do the following:
+npm run test -- '<path_to_test_file>' -t '<test_pattern/name>'
+If you are using VSCode you can use the Jest Runner extension to easily run subset of tests.
+To create a new release do the following:
+package.json version to the new version (we use the semantic release system for versioning)npm run build to update the lib directory (output with types of the library that gets published to NPM) and commit the updatesDraft a new releaseChoose a tag and type the new version, for example v0.1,1Publish release