S2 Installation

This document lists the platform requirements and installation
instructions for working with the S2 Geometry Library in both
C++ and Python. (The S2 Python interfaces uses SWIG to interact
with the C++ code.)

Requirements

Running the S2 code requires the following:

A MacOSX or Linux platform. (Windows is not supported at this time.)

POSIX support (for getrusage()).

A compatible C++ compiler supporting at least C++11, such as
g++ >= 4.7.

Note: this installation guide uses CMake as the official build system for
S2, which is supported on most major platforms and compilers. The S2
source code assumes you are using CMake and contains
CMakeList.txt files for that purpose.

Although you are free to use your own build system, most of the documentation
within this guide will assume you are using
CMake.

Installation Instructions

Note: thorough testing has only been done on Ubuntu 14.04.3
and MacOSX 10.12.

Setting Up Your Development Environment (Linux)

Note: we recommend you use a Linux package manager such as
apt-get. Alternatively, you may build the dependent
libraries from source.