Download

MacOS users will need git, make and cmake to download and build QuEST, all of which can be obtained with Homebrew, via Terminal

Download the QuEST source files to the current directory via

MacOS users can compile using the inbuilt clang compiler, as per the instructions here. Check clang is a recognised command via

To compile QuEST for multithreaded mode, the compiler must be compatible with OpenMP, which not all clang versions are. Users can download other compatible compilers (such as gcc v8) using Homebrew.

Check that an MPI compiler is available via

To compile QuEST in distributed mode, users need an MPI compiler. The inbuilt clang compiler works fine, but in case you wish to use an alternate base compiler, you can additionally download a compatible OpenMPI compiler via Homebrew

To compile QuEST in GPU-accelerated mode, users must have a MacOS versions earlier than Mojave (see here), and an NVIDIA GPU. Download a CUDA compiler via Homebrew

Users must also use a CUDA-compatible base compiler, like GNU v8 above. Some clang versions are incompatible with some CUDA versions, and will give an error during compilation. Download a specific clang version, such as clang-3.7, via

If successful, the following command will be recognised

Linux users will need git, make and cmake to download and build QuEST, all of which can be obtained with apt and apt-get in the shell.

Download the QuEST source files to the current directory via

QuEST can be compiled in both serial and multithreaded modes with any gcc compiler, inbuilt in the Linux shell. Specific compilers can be obtained with apt

Check that a gcc compiler is available via

To compile QuEST in distributed mode, users need an MPI compiler. The inbuilt gcc compiler works fine, but in case you wish to use an alternate base compiler, you can additionally download a compatible OpenMPI compiler via apt-get

Check that an MPI compiler is available via

To compile QuEST in GPU-accelerated mode, users must have an NVIDIA GPU. Download a CUDA compiler via apt

Additional prior steps are required on some versions of Ubuntu, followed by a reboot, before re-attempting the command above. These include

If successful, the below command will be recognised

Windows users should first download the Build Tools for Visual Studio from here. This will provide both the Developer Powershell for VS and the Developer Command Prompt for VS.

Check installation was successful by opening the Developer Command Prompt and running commands

Next, install Chocolatey by opening the Developer Powershell as an administrator, and running

then

Download make and git in the Developer Powershell, by running

Check this was successful by opening the Developer Command Prompt and running

Next, download a Windows installer for CMake from here. Check it is installed by opening a Developer Command Prompt and running

If you experience difficulties compiling with the inbuilt NMake as per the instructions here, you may additionally downloading Mingw-w64 from here, though its use precludes compiling with GPU-acceleration.

Download the QuEST source files to the current directory via the Developer Command Prompt

QuEST can be compiled in both serial and multithreaded modes with the MSVC compilers installed above.

To compile QuEST in distributed mode, users need an MPI compiler. Windows user should download an OpenMPI installer from here, or from here.

Check that an MPI compiler is available in the Developer Command Prompt via

To compile QuEST in GPU-accelerated mode, users must have an NVIDIA GPU. Download a CUDA compiler via Chocolatey in the Developer Powershell

If successful, the below command will be recognised in the Developer Command Prompt