Setup and install the SDK

Quantum Rings SDK supports CPU only or GPU enabled modes. Quantum Rings SDK also supports the CUDA-Q platform in both CPU only or GPU enabled modes.

Choose the version that is appropriate for your hardware, task, and programming skills using the following table.

Choosing the correct version

If you are …

No NVIDIA GPU (CPU Only mode)

NVIDIA GPU Available

If you need Qiskit integration

trained in
or
want to use Qiskit-like API

Installation Procedure for CPU only Mode

Installation Procedure for GPU Enabled Mode

In addition, install the
Quantum Rings toolkit for Qiskit
interested in using
the CUDA-Q Platform

Installing the Quantum Rings SDK for NVIDIA CUDA-Q

Installing the Quantum Rings SDK for NVIDIA CUDA-Q

Not Supported

Minimum System Requirements

A system with a configuration better than the minimum requirements is advised. Lower configurations may affect the number of qubits that can be supported and may perform poorly.

  • Operating systems supported:

    • Windows 11 Pro

    • Google Colab

    • Debian GNU/Linux 12 (bookworm)

    • OpenSUSE Tumbleweed - Version 20240415

    • Oracle Linux 9.3

    • Ubuntu 22.04.4 LTS

    • macOS Sequoia

    • Windows 11 Pro + WSL2 based Linux Installations

  • 64-bit x86 CPU (14 cores 20 logical processors recommended) on Windows or Linux platforms

  • 64-bit Intel or Apple Silicon CPUs on Apple PCs

  • 32 GB Installed physical memory

  • 18 GB Available physical memory

  • 64-bit Python version 3.11 on Windows

  • 64-bit Python 3.11, 3.12, and 3.13 on various Linux versions

  • 64-bit Python 3.13 on macOS

NVIDIA GPU Support

  • Amphere, compute capabilities 8.0, 8.6

  • Hopper, compute capability 9.0

  • or later

A minimum of 4 GB global memory on the GPU and a compute capability of 8.0 is required to run the SDK. The actual amount of memory required depends upon the number of qubits used and the gate operations involved.

If you are a Windows user, you may be benefitted with shorter load times by running the SDK from a WSL based Linux instance. For a tutorial on installing Linux on Windows using WSL, you may refer: WSL Installation Tutorial