NOTE: cuSpatial depends on cuDF and RMM from RAPIDS.
cuSpatial supports the following operations on spatial and trajectory data:
- Spatial window query
- Point-in-polygon test
- Haversine distance
- Hausdorff distance
- Deriving trajectories from point location data
- Computing distance/speed of trajectories
- Computing spatial bounding boxes of trajectories
Future support is planned for the following operations.
- Temporal window query
- Temporal point query (year+month+day+hour+minute+second+millisecond)
- Point-to-polyline nearest neighbor distance
- Grid-based indexing for points and polygons
- Quadtree-based indexing for large-scale point data
- R-Tree-based indexing for Polygons/Polylines
To install via conda:
conda install -c rapidsai-nightly cuspatial
To build and install cuSpatial from source:
Currently, building cuSpatial requires a source installation of cuDF. Install cuDF by following the instructions
The rest of steps assume the environment variable CUDF_HOME
points to the
root directory of your clone of the cuDF repo, and that the cudf_dev
Anaconda
environment created in step 3 is active.
- export
CUSPATIAL_HOME=$(pwd)/cuspatial
- clone the cuSpatial repo
git clone https://github.com/rapidsai/cuspatial.git $CUSPATIAL_HOME
- Compile and install C++ backend
cd $CUSPATIAL_HOME/cpp
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX
make # (or make -j [n])
make install
cuSpatial should now be installed at $CONDA_PREFIX
. The cuspatial include path
is $CONDA_PREFIX/include/cuspatial/
and the library path is
$CONDA_PREFIX/lib/libcuspatial.so
.
- Compile and install cuSpatial Python wrapper and run Python test code
cd $CUSPATIAL_HOME/python/cuspatial
python setup.py build_ext --inplace
python setup.py install
- Run python test code
First, add the cuSpatial Python API path to PYTHONPATH
(there are tools under
tests subdir): export PYTHONPATH=$CUSPATIAL_HOME/python/cuspatial
Some tests using toy data can be run directly, e.g.,
python $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests/pip2_test_soa_toy.py
However, many test code uses real data from an ITS (Intelligent Transportation System) application. You will need to follow instructions at data/README.md to generate data for these test code. Alternatively, you can download the preprocessed data ("locust.", "its_4326_roi.", "itsroi.ply" and "its_camera_2.csv") from here. Extract the files and put them directly under $CUSPATIAL_HOME/data for quick demos. A brief description of these data files and their semantic roles in the ITS application can be found here TODO THIS IS MISSING
After data are downloaded and/or pre-processed, you can run the python test code:
python $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests/pip2_verify.py
python $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests/traj2_test_soa3.py
python $CUSPATIAL_HOME/python/cuspatial/cuspatial/tests/stq_test_soa1.py
NOTE: Currently, cuSpatial supports reading point/polyine/polygon data using Structure of Array (SoA) format (more readers are being developed). Alternatively, python users can read any point/polyine/polygon data using existing python packages, e.g., Shapely, to generate numpy arrays and feed them to cuSpatial python APIs.