Installation#

Pre-requisites#

This section describes the recommended dependencies to use nvImageCodec.

  • Linux distro:
    • x86_64

      • Debian 11, 12

      • Fedora 39

      • RHEL 8, 9

      • OpenSUSE 15

      • SLES 15

      • Ubuntu 20.04, 22.04

      • WSL2 Ubuntu 20.04

    • arm64-sbsa

      • RHEL 8, 9

      • SLES 15

      • Ubuntu 20.04, 22.04

    • aarch64-jetson (CUDA Toolkit >= 12.0)

      • Ubuntu 22.04

  • Windows

  • NVIDIA driver >= 520.56.06

  • CUDA Toolkit > = 11.8

  • Python >= 3.8

  • GCC >= 9.4

  • cmake >= 3.18

Install nvImageCodec library#

You can download and install the appropriate built binary packages from the nvImageCodec Developer Page or install nvImageCodec Python from PyPI as it is described below.

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvimgcodec-cu11

CUDA 12.x

pip install nvidia-nvimgcodec-cu12

CUDA 12.x (Tegra platforms)

pip install nvidia-nvimgcodec-tegra-cu12

Install optional dependencies#

You can also install optional dependencies to run the nvjpeg, nvjpeg2k and nvtiff extensions. To install nvImageCodec with all the optional dependencies, you can do

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvimgcodec-cu11[all]

CUDA 12.x

pip install nvidia-nvimgcodec-cu12[all]

CUDA 12.x (Tegra platforms)

pip install nvidia-nvimgcodec-tegra-cu12[all]

Alternatively, you can specify a subset of the dependencies: nvjpeg, nvjpeg2k, nvtiff. Here are some examples:

Example

Instructions

nvjpeg2k extension support

pip install nvidia-nvimgcodec-cu11[nvjpeg2k]

nvjpeg2k and nvtiff extension support

pip install nvidia-nvimgcodec-cu11[nvjpeg2k+nvtiff]

In the following subsections, you can see how to install those dependencies manually, instead of relying on nvimagecodec’s “extra” packages.

Manual installation of nvJPEG library#

If you do not have CUDA Toolkit installed, or you would like install nvJPEG library independently, you can install it manually as a Python package

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvjpeg-cu11

CUDA 12.x

pip install nvidia-nvjpeg-cu12

Manual installation of nvJPEG2000 library#

nvJPEG2000 library can be installed in the system, or installed as a Python package. For the latter, follow the instructions below.

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvjpeg2k-cu11

CUDA 12.x

pip install nvidia-nvjpeg2k-cu12

CUDA 12.x (Tegra platforms)

pip install nvidia-nvjpeg2k-tegra-cu12

Please see also nvJPEG2000 installation documentation for more information.

Manual installation of nvTIFF library#

nvTIFF library can be installed in the system, or installed as a Python package. For the latter, follow the instructions below.

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvtiff-cu11

CUDA 12.x

pip install nvidia-nvtiff-cu12

CUDA 12.x (Tegra platforms)

pip install nvidia-nvtiff-tegra-cu12

Please see also nvTIFF installation documentation for more information.

Manual installation of nvCOMP library#

nvCOMP library can be installed in the system, or installed as a Python package. For the latter, follow the instructions below. nvCOMP is required if you want to use nvTIFF with images that use Deflate compression.

CUDA version

Instructions

CUDA 11.x

pip install nvidia-nvcomp-cu11

CUDA 12.x

pip install nvidia-nvcomp-cu12

Please see also nvCOMP installation documentation for more information.