Install & Compatibility
Where this runs
tested against v2.4.6 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
build_error
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 14.5s · import 0.000s · 344MB
348MB installed
● package 348MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
QiskitConnector
✓ from qiskit_connector import QiskitConnector
This quickstart demonstrates how to initialize the Qiskit Connector, authenticate with IBM Quantum, and retrieve an available backend. Ensure your IBM Quantum API token is set as an environment variable named `IBM_QUANTUM_TOKEN`.
import os
from qiskit_connector import QiskitConnector
# Set your IBM Quantum API token as an environment variable, e.g.,
# os.environ['IBM_QUANTUM_TOKEN'] = 'YOUR_API_TOKEN'
# os.environ['IBM_QUANTUM_URL'] = 'https://quantum-computing.ibm.com/api' # Optional, defaults to this
def main():
token = os.environ.get("IBM_QUANTUM_TOKEN")
url = os.environ.get("IBM_QUANTUM_URL", "https://quantum-computing.ibm.com/api")
if not token:
print("Error: IBM_QUANTUM_TOKEN environment variable not set. Please set it to your IBM Quantum API token.")
return
try:
# Initialize the connector. 'instance' can be adjusted to your specific IBM Quantum instance.
connector = QiskitConnector(
token=token,
instance="ibmq-q/open/main",
url=url
)
authenticated = connector.authenticate()
if authenticated:
print("Successfully authenticated with IBM Quantum.")
backend = connector.get_backend()
if backend:
print(f"Selected backend: {backend.name}")
print(f"Backend status: {backend.status().status_msg}")
# You can now use the 'backend' object with Qiskit for running circuits.
else:
print("No suitable backend found. Check availability or instance settings.")
else:
print("Authentication failed. Check your token and URL.")
except Exception as e:
print(f"An unexpected error occurred: {e}")
if __name__ == "__main__":
main()
Debug
Known issues
breakingThe library is tightly coupled with `qiskit` and `qiskit-ibm-provider`. Significant changes or version mismatches in these underlying dependencies can lead to runtime errors or unexpected behavior. While the library updates frequently, ensure compatibility.fixConsult the `qiskit-connector` PyPI page for its specific dependency requirements. Upgrade `qiskit-connector` and related `qiskit` packages to compatible versions if experiencing issues.
affects: All versions, especially across major Qiskit releases.
gotchaAuthentication heavily relies on a valid IBM Quantum API token. An expired, incorrect, or missing `IBM_QUANTUM_TOKEN` environment variable (or directly passed `token` parameter) will consistently result in authentication failures.fixObtain an up-to-date IBM Quantum API token from your IBM Quantum account settings. Set it as an environment variable named `IBM_QUANTUM_TOKEN` before running your script, or pass it explicitly to the `QiskitConnector` constructor.
affects: All versions
gotchaEven with successful authentication, `connector.get_backend()` might return `None` if no suitable quantum backend is currently available, online, or accessible under your IBM Quantum plan and specified `instance`.fixAlways check if the `backend` object returned by `get_backend()` is not `None` before attempting to use it. Verify backend availability on the IBM Quantum platform and ensure your `instance` parameter (e.g., 'ibmq-q/open/main') is correct and accessible.
affects: All versions
Upgrade
Version history
2.4.6latest on PyPI · released Jan 7, 2026
Audit
Dependencies
qiskitrequiredCore Qiskit SDK integration
qiskit-ibm-providerrequiredConnects to IBM Quantum Experience
qiskit-aerrequiredLocal simulator backend for Qiskit