Getting Started¶

Getting the source code¶

You can download the latest stable released version, or you can get the latest source code version by cloning our git repository:

git clone https://github.com/Shapelets/Khiva

Dependencies¶

Khiva relies on a number of open source libraries and tools which are required to get it running.

Tools:

A Build manager to control the compilation process CMake.
A dependency manager Conan.
Python 3.
Pip3.
Documentation builders Doxygen and sphinx.
Graphviz and Dot.
A C++ compiler, it can be either Clang, GCC or Visual Studio C++ Compiler.

Note

All versions of Khiva Library require a fully C++11-compliant compiler.

Libraries:

OpenCL library for you GPU card (Intel, AMD, or Nvidia).
To run on accelerators like GPUs, Arrayfire.
To test the functionality provided by Khiva, Google Test.
To benchmark Khiva, Google Benchmark.
Boost.
Eigen.

Linux¶

We will use Ubuntu 16.04 LTS as our example linux distribution.

Once we have installed all Khiva dependencies, we are ready to build and install Khiva. First, go to the directory where the source code is stored.

mkdir build
cd build
cmake ..
make install

It will install the library in /usr/local/lib and /usr/local/include folders.

In case ArrayFire is not installed in the system default directories, it is also required to add the Arrayfire lib folder to the environment variable LD_LIBRARY_PATH.

export LD_LIBRARY_PATH="/pathToArrayfire/arrayfire/lib:$LD_LIBRARY_PATH"

Mac OS¶

Once we have installed all Khiva dependencies, we are ready to build and install Khiva. First, go to the directory where the source code is stored:

mkdir build
cd build
cmake ..
make install

It will install the library in /usr/local/lib and /usr/local/include folders.

Windows¶

First, we need to ensure the Graphviz, Dot and Doxygen binaries are included in the environment variable PATH. Once we have installed all Khiva dependencies, we are ready to build and install Khiva. So, go to the directory where the source code is stored and proceed as follows:

mkdir build
cd build
cmake ..
make install

It will install the library in C:/Program Files/Khiva/v0/lib and C:/Program Files/Khiva/v0/include folders.