User Guides

This tutorial provides an introduction to HPVM for new users of the HVPM project. It begins with instructions on how to build HPVM, then works through examples on programming in HPVM and compiling down to various types of hardware.

Building HPVM

First, checkout the HPVM repository using:

git clone --recursive -b main
cd hpvm/

Next, build hpvm using the provided installer as follows:

./ -j<n> DCMAKE_BUILD_TYPE=Release

This script will download the required LLVM release and build HPVM. In this, `<n>` should be replaced with the number of threads to build with. Note that HPVM requires nearly 16 GB of RAM to build single-threaded and this increases (though not linearly) as the number of threads is increased. If you encounter Out of Memory or similar errors during compilation, try decreasing the number of threads.

For more details on building HPVM, check out the detailed build instructions.


Once you have built HPVM, please refer to the following tutorials for more information on using HPVM.

For more detailed usages, check out the components and developer documentation.

How-to Guides