Skip to content

install.md

Latest commit

 

History

History
76 lines (47 loc) · 2.89 KB

install.md

File metadata and controls

76 lines (47 loc) · 2.89 KB
Raw

Installation

Runtime Requirements

cuda.bindings supports the same platforms as CUDA. Runtime dependencies are:

  • Linux (x86-64, arm64) and Windows (x86-64)
  • Python 3.9 - 3.13
  • Driver: Linux (450.80.02 or later) Windows (456.38 or later)
  • Optionally, NVRTC, nvJitLink, and NVVM from CUDA Toolkit 12.x
The optional CUDA Toolkit components can be installed via PyPI, Conda, OS-specific package managers, or local installers (as described in the CUDA Toolkit [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) and [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) Installation Guides).

Starting from v12.8.0, cuda-python becomes a meta package which currently depends only on cuda-bindings; in the future more sub-packages will be added to cuda-python. In the instructions below, we still use cuda-python as example to serve existing users, but everything is applicable to cuda-bindings as well.

Installing from PyPI

$ pip install -U cuda-python

Install all optional dependencies with:

pip install -U cuda-python[all]

Where the optional dependencies are:

  • nvidia-cuda-nvrtc-cu12 (Provides NVRTC shared library)
  • nvidia-nvjitlink-cu12>=12.3 (Provides nvJitLink shared library)
  • nvidia-cuda-nvcc-cu12 (Provides NVVM shared library)

Installing from Conda

$ conda install -c conda-forge cuda-python

Installing from Source

Requirements

  • CUDA Toolkit headers1
  • CUDA Runtime static library2

Source builds require that the provided CUDA headers are of the same major.minor version as the cuda.bindings you're trying to build. Despite this requirement, note that the minor version compatibility is still maintained. Use the CUDA_HOME (or CUDA_PATH) environment variable to specify the location of your headers. For example, if your headers are located in /usr/local/cuda/include, then you should set CUDA_HOME with:

$ export CUDA_HOME=/usr/local/cuda

See Environment Variables for a description of other build-time environment variables.

Only `cydriver`, `cyruntime` and `cynvrtc` are impacted by the header requirement.

Editable Install

You can use

$ pip install -v -e .

to install the module as editable in your current Python environment (e.g. for testing of porting other libraries to use the binding).

Footnotes

  1. User projects that cimport CUDA symbols in Cython must also use CUDA Toolkit (CTK) types as provided by the cuda.bindings major.minor version. This results in CTK headers becoming a transitive dependency of downstream projects through CUDA Python. ↩

  2. The CUDA Runtime static library (libcudart_static.a on Linux, cudart_static.lib on Windows) is part of the CUDA Toolkit. If using conda packages, it is contained in the cuda-cudart-static package. ↩