Building on Ubuntu
Installing on Ubuntu
Quickstart
If you have access to Codespaces, you can launch a Linux VM in the browser or in Visual Studio Code with all the pre-requisites installed:
- Go to https://github.com/microsoft/Accera, use the "<> Code" drop-down menu, and in the Codespaces tab, click Create codespace on main.
sh build.sh
Step 2 will take some time to build Accera's LLVM fork. Grab a coffee and come back in about an hour or so.
Build Script
If you do not have access to Codespaces or prefer to build locally, you can use the build.sh script to build Accera.
Install Dependencies
Accera requires the following tools and libraries:
- A C++ compiler that supports C++ 17, such as GCC 8
- CMake 3.14 or newer
- Python 3.7 or newer
- Ninja
- Ccache
- LLVM OpenMP 5, if using parallelization
sudo apt update
sudo apt-get install gcc-8 g++-8 cmake python3 python3-pip ninja-build ccache libomp-11-dev pkg-config zip
Some Ubuntu distributions install an older version of CMake. Check the version of cmake using cmake --version, and download a newer version if older than 3.14.
Clone Accera
Install git if you don't already have it:
sudo apt-get install git
Clone the git repository
git clone --recurse-submodules https://github.com/microsoft/Accera
Build and install Accera
Run the build.sh script to install dependencies and build the Accera Python package (replace <path_to_accera> with the path to the cloned Accera repository).
cd <path_to_accera>
sh ./build.sh
Update or install the resulting .whl files from the dist subdirectory. The --find-links option tells pip to look at the dist subdirectory for the dependent packages.
The name depends on your Python version, your OS and your CPU architecture.
pip install -U ./dist/accera-0.0.1-cp37-cp37m-linux_x86_64.whl --find-links=dist
CMake Builds
Accera can also be built using CMake (intended for expert users).
Install dependencies
cd <path_to_accera>
git submodule init
git submodule update
./external/vcpkg/bootstrap-vcpkg.sh
./external/vcpkg/vcpkg install catch2 tomlplusplus accera-llvm --overlay-ports=external/llvm
The last command typically takes a few hours to build and then install Accera's fork of LLVM. We recommend reserving at least 20GB of disk space for the LLVM build.
Configure CMake
cd <path_to_accera>
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -G Ninja
Build and run tests
cmake --build . --config Release
ctest -C Release
Install
cmake --build . --config Release --target install