/ldbc_snb_docs

Specification of the LDBC Social Network Benchmark

Primary LanguageTeXApache License 2.0Apache-2.0

LDBC_LOGO

LDBC SNB Documentation

Build Status

[latest PDF (0.4.0-SNAPSHOT)] [stable PDF (0.3.3)]

Benchmark specification

For a quick overview of LDBC SNB, start with our presentation.

For a guide on how to develop benchmark implementations, please check out the benchmark workflow file.

Compatibility

The two SNB workloads (Interactive/BI) are stored in different repositories:

How to cite LDBC benchmarks

How to build the this document

This repository contains the LaTeX source for the specification of the LDBC Social Network Benchmark. This README discusses how to build the specification PDF from source.

Generating query cards

To get consistent formatting, query cards are generated from query specifications defined in YAML format. This is a necessary step to compile to the document.

Install Pandoc, Python3, and the required packages:

sudo apt-get install -y pandoc python3 python3-pip python3-setuptools
pip3 install -r requirements.txt

Building the document

To build the document, run make or make texfot. The latter requires Perl but gives you a cleaner output.

We also provide an image on Docker Hub for building the document. To use it, run:

docker run -v `pwd`/:/mnt/ ldbc/docs /bin/bash -c \
  "cd /mnt/ && ./generate-tex.py && make generate_query_cards texfot compile_query_cards"; \
  sudo chown -R ${USER}:${USER} .

You can also compile the image manually by issuing:

docker build . --tag ldbc/docs