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
- x86_64
  
  Microsoft Visual C++ Redistributable
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.

nvImageCodec Python for CUDA 11.x
```
pip install nvidia-nvimgcodec-cu11
```
nvImageCodec Python for CUDA 12.x
```
pip install nvidia-nvimgcodec-cu12
```
nvImageCodec Python for Tegra (CUDA 12.x only)
```
pip install nvidia-nvimgcodec-tegra-cu12
```

Optional installation of nvJPEG library#

If you do not have CUDA Toolkit installed, or you would like install nvJPEG library independently, you can use the instructions described below.

Install the nvidia-pyindex module
```
pip install nvidia-pyindex
```
Install nvJPEG for CUDA 11.x
```
pip install nvidia-nvjpeg-cu11
```
Install nvJPEG for CUDA 12.x
```
pip install nvidia-nvjpeg-cu12
```

Optional 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.

Install the nvidia-pyindex module
```
pip install nvidia-pyindex
```
Install nvJPEG2000 for CUDA 11.x
```
pip install nvidia-nvjpeg2k-cu11
```
Install nvJPEG2000 for CUDA 12.x
```
pip install nvidia-nvjpeg2k-cu12
```
Install nvJPEG2000 for CUDA 12.x on Tegra platforms
```
pip install nvidia-nvjpeg2k-tegra-cu12
```

Please see also nvJPEG2000 installation documentation for more information

Optional 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.

Install nvTIFF for CUDA 11.x
```
pip install nvidia-nvtiff-cu11
```
Install nvTIFF for CUDA 12.x
```
pip install nvidia-nvtiff-cu12
```
Install nvTIFF for CUDA 11.x on Tegra platforms
```
pip install nvidia-nvtiff-tegra-cu11
```
Install nvTIFF for CUDA 12.x on Tegra platforms
```
pip install nvidia-nvtiff-tegra-cu12
```

Please see also nvTIFF installation documentation for more information

Optional 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.

Install nvCOMP for CUDA 11.x
```
pip install nvidia-nvcomp-cu11
```
Install nvCOMP for CUDA 12.x
```
pip install nvidia-nvcomp-cu12
```

Please see also nvCOMP installation documentation for more information