Update Notebook with GeoSeries Usage and Add Notebook Tests

.github/workflows/pr.yaml

@@ -17,6 +17,7 @@ jobs:
       - conda-cpp-tests
       - conda-python-build
       - conda-python-tests
+      - conda-notebook-tests
       - docs-build
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/pr-builder.yaml@branch-23.04
@@ -47,6 +48,16 @@ jobs:
     uses: rapidsai/shared-action-workflows/.github/workflows/conda-python-tests.yaml@branch-23.04
     with:
       build_type: pull-request
+  conda-notebook-tests:
+    needs: conda-python-build
+    secrets: inherit
+    uses: rapidsai/shared-action-workflows/.github/workflows/custom-job.yaml@branch-23.04
+    with:
+      build_type: pull-request
+      node_type: "gpu-latest-1"
+      arch: "amd64"
+      container_image: "rapidsai/ci:latest"
+      run_script: "ci/test_notebooks.sh"
   docs-build:
     needs: conda-python-build
     secrets: inherit

ci/test_notebooks.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+# Copyright (c) 2020-2023, NVIDIA CORPORATION.
+
+set -euo pipefail
+
+. /opt/conda/etc/profile.d/conda.sh
+
+rapids-logger "Generate notebook testing dependencies"
+rapids-dependency-file-generator \
+  --output conda \
+  --file_key test_notebooks \
+  --matrix "cuda=${RAPIDS_CUDA_VERSION%.*};arch=$(arch);py=${RAPIDS_PY_VERSION}" | tee env.yaml
+
+rapids-mamba-retry env create --force -f env.yaml -n test
+
+# Temporarily allow unbound variables for conda activation.
+set +u
+conda activate test
+set -u
+
+rapids-print-env
+
+rapids-logger "Downloading artifacts from previous jobs"
+CPP_CHANNEL=$(rapids-download-conda-from-s3 cpp)
+PYTHON_CHANNEL=$(rapids-download-conda-from-s3 python)
+
+rapids-mamba-retry install \
+  --channel "${CPP_CHANNEL}" \
+  --channel "${PYTHON_CHANNEL}" \
+  cuspatial libcuspatial
+
+NBTEST="$(realpath "$(dirname "$0")/utils/nbtest.sh")"
+pushd notebooks
+
+# Add notebooks that should be skipped here
+# (space-separated list of filenames without paths)
+SKIPNBS=""
+
+# Set SUITEERROR to failure if any run fails
+SUITEERROR=0
+
+set +e
+for nb in $(find . -name "*.ipynb"); do
+    nbBasename=$(basename ${nb})
+    if (echo " ${SKIPNBS} " | grep -q " ${nbBasename} "); then
+        echo "--------------------------------------------------------------------------------"
+        echo "SKIPPING: ${nb} (listed in skip list)"
+        echo "--------------------------------------------------------------------------------"
+    else
+        nvidia-smi
+        ${NBTEST} ${nbBasename}
+        SUITEERROR=$((SUITEERROR | $?))
+    fi
+done
+
+exit ${SUITEERROR}

ci/utils/nbtest.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# Copyright (c) 2023, NVIDIA CORPORATION.
+
+MAGIC_OVERRIDE_CODE="
+def my_run_line_magic(*args, **kwargs):
+    g=globals()
+    l={}
+    for a in args:
+        try:
+            exec(str(a),g,l)
+        except Exception as e:
+            print('WARNING: %s\n   While executing this magic function code:\n%s\n   continuing...\n' % (e, a))
+        else:
+            g.update(l)
+
+def my_run_cell_magic(*args, **kwargs):
+    my_run_line_magic(*args, **kwargs)
+
+get_ipython().run_line_magic=my_run_line_magic
+get_ipython().run_cell_magic=my_run_cell_magic
+
+"
+
+NO_COLORS=--colors=NoColor
+EXITCODE=0
+NBTMPDIR="$WORKSPACE/tmp"
+mkdir -p ${NBTMPDIR}
+
+for nb in $*; do
+    NBFILENAME=$1
+    NBNAME=${NBFILENAME%.*}
+    NBNAME=${NBNAME##*/}
+    NBTESTSCRIPT=${NBTMPDIR}/${NBNAME}-test.py
+    shift
+
+    echo --------------------------------------------------------------------------------
+    echo STARTING: ${NBNAME}
+    echo --------------------------------------------------------------------------------
+    jupyter nbconvert --to script ${NBFILENAME} --output ${NBTMPDIR}/${NBNAME}-test
+    echo "${MAGIC_OVERRIDE_CODE}" > ${NBTMPDIR}/tmpfile
+    cat ${NBTESTSCRIPT} >> ${NBTMPDIR}/tmpfile
+    mv ${NBTMPDIR}/tmpfile ${NBTESTSCRIPT}
+
+    echo "Running \"ipython ${NO_COLORS} ${NBTESTSCRIPT}\" on $(date)"
+    echo
+    time bash -c "ipython ${NO_COLORS} ${NBTESTSCRIPT}; EC=\$?; echo -------------------------------------------------------------------------------- ; echo DONE: ${NBNAME}; exit \$EC"
+    NBEXITCODE=$?
+    echo EXIT CODE: ${NBEXITCODE}
+    echo
+    EXITCODE=$((EXITCODE | ${NBEXITCODE}))
+done
+
+exit ${EXITCODE}

dependencies.yaml

@@ -24,6 +24,11 @@ files:
       - cudatoolkit
       - py_version
       - test_python
+  test_notebooks:
+    output: none
+    includes:
+      - notebooks
+      - py_version
   checks:
     output: none
     includes:
@@ -147,6 +152,13 @@ dependencies:
           - numpydoc
           - pydata-sphinx-theme
           - sphinx<6
+  notebooks:
+    common:
+      - output_types: [conda, requirements]
+        packages:
+          - ipython
+          - notebook
+          - shapely
   py_version:
     specific:
       - output_types: conda