Skip to content
This repository has been archived by the owner on Feb 11, 2022. It is now read-only.


Repository files navigation

Qiskit Random Number Generation

License Build Status

Qiskit is an open-source framework for working with noisy intermediate-scale quantum computers (NISQ) at the level of pulses, circuits, and algorithms.

This project contains support for Random Number Generation using Qiskit and IBM Quantum Experience backends. The resulting raw numbers can then be passed to Cambridge Quantum Computing (CQC) randomness extractors to get higher-quality random numbers.


You can install the project using pip:

pip install qiskit_rng

PIP will handle all python dependencies automatically, and you will always install the latest (and well-tested) version.


Setting up the IBM Quantum Provider

You will need setup your IBM Quantum Experience account and provider in order to access IBM Quantum backends. See qiskit-ibmq-provider for more details.

Generating random numbers using an IBM Quantum backend

To generate random numbers using an IBM Quantum backend:

from qiskit import IBMQ
from qiskit_rng import Generator

rng_provider = IBMQ.get_provider(hub='MY_HUB', group='MY_GROUP', project='MY_PROJECT')
backend = rng_provider.backends.ibmq_ourence

generator = Generator(backend=backend)
output = generator.sample(num_raw_bits=1024).block_until_ready()

The output you get back contains useful information such as the Weak Source of Randomness (result.wsr) used to generate the circuits, the resulting bits (result.raw_bits), and the Mermin correlator value (result.mermin_correlator).

Using CQC extractors to get highly random output

If you have access to the CQC extractors, you can feed the outputs from the previous step to obtain higher quality random numbers:

random_bits = output.extract()

The code above uses the default parameter values, but the extractor is highly configurable. See documentation for some use case examples and parameter suggestions.


Usage and API documentation can be found here.


Apache License 2.0.