Install (CPU-only)

Overview

Use this procedure if your system does not have a compatible NVIDIA GPU or if you do not intend to use GPU acceleration.

If you have a supported NVIDIA GPU and want GPU-enabled execution, see Install (GPU-enabled).

Note

Install either the CPU version or the GPU version — not both. The GPU-enabled installation includes CPU support.

If you are using the NVIDIA GB10 Grace Blackwell Superchip, you may install either CPU or GPU mode. For GPU mode, see Install (GPU-enabled).

Supported Python versions

The SDK requires 64-bit Python:

  • Python 3.11

  • Python 3.12

  • Python 3.13

  • Python 3.14

See System Requirements for full platform and memory requirements.

Install on Windows

Install using pip:

pip install QuantumRingsLib

Alternatively:

pip install quantumrings[cpu]

Many users manage environments using Anaconda. If creating a new environment, select Python 3.11–3.14.

Note

If pip cannot find the package, try:

pip install --extra-index-url https://pypi.python.org/pypi QuantumRingsLib

In some cases, restarting the system may be required.

Install on macOS

Install Python 3.11–3.14 from https://www.python.org/downloads/macos/. Other Python distributions (including Conda) are not supported due to ABI incompatibility.

Create and activate a virtual environment:

python3.13 -m venv myenv
source myenv/bin/activate

Install the SDK:

pip install QuantumRingsLib

Install on Linux

Platform support

The SDK supports manylinux_2_34_x86_64 platforms based on 64-bit x86 processors. glibc 2.34 or later is required.

To check your system:

import platform
platform.platform()

Look for the glibc version in the output.

Create a virtual environment

On Debian/Ubuntu:

python3.13 -m venv myenv
source myenv/bin/activate

On Oracle Linux or OpenSUSE:

python3.11 -m venv myenv
source myenv/bin/activate

Install the SDK

pip install QuantumRingsLib

Optional dependencies

If you encounter a libgomp.so error, install gcc (using your distribution’s package manager).

Install on Google Colab

In a notebook cell:

pip install QuantumRingsLib

Restart the runtime after installation.

For notebook usage, see Notebooks. To run Jupyter notebooks locally in the same environment: pip install notebook.

Verify the installation

In Python:

import QuantumRingsLib
print(QuantumRingsLib.__version__)

If a version number is printed without error, the installation succeeded.

Troubleshooting

  • glibc version: Ensure glibc 2.34 or later on Linux.

  • libgomp error: Install gcc if libgomp.so is missing.

  • Package not found: Use the --extra-index-url option shown above.

For additional issues, see Troubleshooting.