Building Scanner from Source

To use Scanner, you either need to build it yourself or use one of our Docker images. See the Docker section for using Docker. Otherwise, follow the steps below to build from the project source.

1. Installing out-of-tree dependencies

Scanner requires the following packages:

• CMake >= 3.2.0
• Python 2.7
• protobuf >= 3.0.0
• glog >= 0.3.0
• ffmpeg >= 3.0.2
• gRPC 1.7.2

Scanner optionally requires:

• CUDA >= 8.0

Scanner Python requires:

• numpy
• scipy
• protobuf
• toml
• enum34
• grpcio

The Scanner stdlib optionally requires:

• OpenCV >= 3.2.0
• Caffe
• Halide
• OpenFace

Installing these packages varies vastly based on your OS, and often requires installing many other dependencies. We document this process for a small number of platforms in our scanner-docker repository. Look at <your-os>/Dockerfile for what commands to run. Currently, we support:

• Ubuntu 16.04

2. Installing in-tree dependencies

First, clone the repo:

git clone https://github.com/scanner-research/scanner && cd scanner
export SCANNER_DIR=`pwd`

Then to build the in-tree dependencies:

cd ${SCANNER_DIR}/thirdparty && mkdir build && cd build
cmake .. && make -j`nproc`

3. Building the main project

Lastly, we need to build the project proper.

cd ${SCANNER_DIR} && mkdir build && cd build
cmake -D BUILD_IMGPROC_OPS=ON ..
make -j`nproc`

Once the project is built, head over to Running Scanner to start processing some videos.