Quick Start (5 Minutes)

This guide walks you through installing the SDK, configuring credentials, and running your first quantum circuit.

Step 1 — Install the SDK

Install the SDK:

pip install QuantumRingsLib

For a virtual environment and other options (GPU, macOS, Linux), see Install (CPU-only) and Install (GPU-enabled).

Step 2 — Configure Credentials

Save your Quantum Rings credentials locally:

from QuantumRingsLib import QuantumRingsProvider

provider = QuantumRingsProvider(
    token="<YOUR_TOKEN>",
    name="<YOUR_ACCOUNT_NAME>"
)

provider.save_account(
    token="<YOUR_TOKEN>",
    name="<YOUR_ACCOUNT_NAME>"
)

See Quantum Rings credentials for other credential options.

Step 3 — Run a Simple Circuit

Create and execute a simple 2-qubit Bell state circuit:

from QuantumRingsLib import QuantumCircuit, QuantumRingsProvider

provider = QuantumRingsProvider()
backend = provider.get_backend("scarlet_quantum_rings")

qc = QuantumCircuit(2, name="bell_pair")
qc.h(0)
qc.cx(0, 1)
qc.measure_all()

job = backend.run(qc, shots=1000)
result = job.result()

print(result.get_counts())

You should see output similar to:

{'00': ~500, '11': ~500}

This confirms the SDK is installed and your credentials are working.

Next Steps