System Setup

Supported Platforms

• Ubuntu 18.04 (LTS)
• macOS 10.14+

If you are not running natively on one of the above supported platforms:

1. If you wish to do development on Terrier, the recommended approach is to use a VM running one of the supported OSes.
2. If you merely wish to run Terrier, Docker may be used instead of a VM.
3. CLion's Full Remote Mode allows you to have CLion running on your native OS, but compiling, executing and debugging will happen on Docker (or any remote ssh-accessible Linux host). // TODO(wanshenl) <-- ping me if you need to fight Docker to do this

Toolchain

• C++17-enabled compiler (GCC 7.0+ or Apple Clang 10.0+)
• CMake 3.2+
• LLVM 8.0+

Ubuntu Setup

1. Clone the Terrier repository:

   git clone --recursive https://github.com/cmu-db/terrier.git

2. Install the package dependencies:

   cd terrier/script/installation
   sudo bash packages.sh

3. Proceed to Building Terrier.

macOS Setup

1. Command Line Tools: Download Command Line Tools for your system from Apple (login required). The latest confirmed working version is Command Line Tools for Xcode 9.4.

2. Clone the Terrier repository:

   git clone --recursive https://github.com/cmu-db/terrier.git

3. Install the package dependencies:

   cd terrier/script/installation
   bash packages.sh

   If you encounter permissions issues, run brew doctor and follow the instructions.

4. Proceed to Building Terrier.