Build and Install cuSpatial From Source#

Pre-requisites#

gcc >= 7.5
cmake >= 3.26.4
miniforge

Fetch cuSpatial repository#

export `CUSPATIAL_HOME=$(pwd)/cuspatial` && \
git clone https://github.com/rapidsai/cuspatial.git $CUSPATIAL_HOME

Install dependencies#

export CUSPATIAL_HOME=$(pwd)/cuspatial
clone the cuSpatial repo

conda env create -n cuspatial --file conda/environments/all_cuda-118_arch-x86_64.yaml

Build cuSpatial#

From the cuSpatial Dev Container:#

Execute build-cuspatial-cpp to build libcuspatial. The following options may be added.

-DBUILD_TESTS=ON: build libcuspatial unit tests.
-DBUILD_BENCHMARKS=ON: build libcuspatial benchmarks.
-DCMAKE_BUILD_TYPE=Debug: Create a Debug build of libcuspatial (default is Release). In addition, build-cuspatial-python to build cuspatial cython components.

From Bare Metal:#

Compile libcuspatial (C++), cuspatial (cython) and C++ tests:

cd $CUSPATIAL_HOME && \
chmod +x ./build.sh && \
./build.sh libcuspatial cuspatial tests

Additionally, the following options are also commonly used:

benchmarks: build libcuspatial benchmarks
clean: remove all existing build artifacts and configuration Execute ./build.sh -h for full list of available options.

Validate Installation with C++ and Python Tests#

Note

To manage difference between branches and build types, the build directories are located at $CUSPATIAL_HOME/cpp/build/[release|debug] depending on build type, and $CUSPATIAL_HOME/cpp/build/latest. is a symbolic link to the most recent build directory. On bare metal builds, remove the extra latest level in the path below.

C++ tests are located within the $CUSPATIAL_HOME/cpp/build/latest/gtests directory.
Python tests are located within the $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests directory.

Execute C++ tests:

ninja -C $CUSPATIAL_HOME/cpp/build/latest test

Execute Python tests:

pytest $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests/