rapids_cpm_nvcomp

Added in version v22.06.00.

Allow projects to find or build nvCOMP via CPM with built-in tracking of these dependencies for correct export support.

Uses the version of nvCOMP specified in the version file for consistency across all RAPIDS projects.

rapids_cpm_nvcomp( USE_PROPRIETARY_BINARY <ON|OFF>
                   [BUILD_EXPORT_SET <export-name>]
                   [INSTALL_EXPORT_SET <export-name>]
                   [<CPM_ARGS> ...])

USE_PROPRIETARY_BINARY

By enabling this flag and using the software, you agree to fully comply with the terms and conditions of nvCOMP’s NVIDIA Software License Agreement, found at https://developer.download.nvidia.com/compute/nvcomp/2.3/LICENSE.txt.

nvCOMP is distributed as a pre-built proprietary binary. This flag is required for rapids-cmake to download nvCOMP; without it, nvCOMP can only be found if already installed on the system.

Note

If an override entry exists for the nvCOMP package it MUST have a proprietary_binary entry for this flag to do anything. Any override without this entry is considered to invalidate the existing proprietary binary entry.

BUILD_EXPORT_SET: Record that a CPMFindPackage() for nvcomp is required in our build directory export set.
INSTALL_EXPORT_SET: Record that a find_dependency() for nvcomp is required in our install directory export set.

Note

Installation of nvcomp will occur if an INSTALL_EXPORT_SET is provided, and nvcomp is added to the project via add_subdirectory by CPM.

CPM_ARGS: Any arguments after CPM_ARGS will be forwarded to the underlying nvcomp CPMFindPackage`() call

Result Targets

nvcomp::nvcomp target will be created nvcomp::nvcomp_cpu target will be created nvcomp::nvcomp_static target might be created nvcomp::nvcomp_cpu_static target might be created

Result Variables

nvcomp_SOURCE_DIR is set to the path to the source directory of nvCOMP. nvcomp_BINARY_DIR is set to the path to the build directory of nvCOMP. nvcomp_ADDED is set to a true value if nvCOMP has not been added before. nvcomp_VERSION is set to the version of nvCOMP specified by the versions.json. nvcomp_proprietary_binary is set to ON if the proprietary binary is being used