Installation

To run HEAT you will need to install the HEAT docker container from dockerhub.

The links below explain how to install the HEAT docker container and get HEAT up and running.

• HEAT via the docker container
  • Installing the docker container
  • To download docker and docker-compose
  • Download HEAT docker container
  • Download HEAT source code from github
  • Starting HEAT with docker
  • Permissions in Docker on Linux
  • Start HEAT in GUI mode
  • Start HEAT in TUI mode

To download test HEAT case (deprecated)

For HEAT versions equal or greater to v4.0, there are test cases inside the container. These tests cases serve two purposes:

• They enable integration testing for HEAT developers in CI

• They enable HEAT users to test their local setup

These test cases can be found in the <HEATsource>/tests directory, where <HEATsource> is the location of your source code. Inside the container, the <HEATsource> directory can be found at: /root/source/HEAT

Previously, you would test your HEAT installation by using a test case provided on the releases tab on github. These instruction are left here for the old versions of HEAT. The test case can be downloaded and extracted by using the following commands (again replacing <tag> with latest version ie vX.X.X):

wget https://github.com/plasmapotential/HEAT/releases/download/<tag>/testCase_<tag>.tar.gz
tar -xvzf testCase_<tag>.tar.gz

Test Case Installation Video (from release tab on github):