1. Requirements

PlinyCompute requires the following libraries and packages to be installed in order to compile and build.

Library Packages
Snappy libsnappy1v5, libsnappy-dev
GSL libgsl-dev
Boost libboost-dev, libboost-program-options-dev, libboost-filesystem-dev, libboost-system-dev
Bison bison
Flex flex

2. Compiling PlinyCompute and building targets

Clone PlinyCompute from GitHub, issuing the following command:

 
$ git clone https://github.com/riceplinygroup/plinycompute.git 

This command will download PlinyCompute in a folder named plinycompute. Make sure you are in that directory by typing:

 
$ cd plinycompute 

In a linux machine the prompt should look something similar to:

 
ubuntu@master:~/plinycompute$

2. Invoke cmake, by default PlinyCompute is built without debug messages with the following command:

 
$ cmake .

However, if you are interested in debugging PlinyCompute, issue the following command:

 
$ cmake -DUSE_DEBUG:BOOL=ON .

Conversely, to turn debugging messages off, issue the following command:

 
$ cmake -DUSE_DEBUG:BOOL=OFF .

Depending on what target you want to build, issue the following command, where <number-of-jobs> is an integer number that allows to execute multiple recipes in parallel; <target> is the name of the target you want to build. Click here to see the list of targets.

 
$ make -j <number-of-jobs> <target>

For example, the following command compiles and builds the executable pdb-cluster (by default created in the folder bin).

 
$ make -j 4 pdb-cluster

3. Deploying PlinyCompute

Click here to deploy as a pseudo cluster in one machine (ideal for testing and debugging).

Click here to deploy in a real cluster with multiple nodes (ideal for processing large datasets)