The instructions below assume that ELL was obtained from GitHub using git. The git client is typically installed by default on Ubuntu systems, but if it isn't, open a terminal and type
sudo apt-get install git
In a terminal, clone the ELL repository by typing
git clone https://github.com/Microsoft/ELL.git
We recommend using the apt-get package manager to download and install prerequisites. First, make sure that apt-get is up to date, by typing
sudo apt-get -y update
Next, you will need gcc and CMake. They are often installed by default on Ubuntu systems, but to confirm type
sudo apt-get install -y gcc cmake
You will also need the dev version of LLVM-3.9. At the time of writing this document, apt-get doesn't yet have the required version of LLVM. To check this, type
apt-cache show llvm-dev
and look for the version number. If the version number is 3.9 or greater, you can simply type sudo apt-get install -y llvm-dev. Otherwise, do the following:
sudo apt-get install -y wget
wget -O - http://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
sudo apt-add-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-3.9 main"
sudo apt-get -y update
sudo apt-get install -y llvm-3.9-dev
Install the BSD editline and history libraries
sudo apt-get install -y libedit-dev
sudo apt-get install zlibc zlib1g zlib1g-dev
ELL can optionally take advantage of the optimized linear algebra libraries in OpenBlas, and generate code documentation using Doxygen. To install these optional dependencies, type
sudo apt-get install -y libopenblas-dev doxygen
Next, use CMake to create a makefile. In the repository root directory, create a build subdirectory and change to that directory:
mkdir build
cd build
Then, invoke cmake:
cmake ..
Important: don't forget the two dots (..) at the end of the command!
Finally, build ELL by typing
make
The generated executables will appear in a directory named ELL/build/bin.
The create code documentation, type
make doc
The Doxygen generated files will appear in ELL/build/doc.