Migrating to v0.13.0: IBM Quantum System Service API rename#

Starting with v0.13.0, the IBM Direct Access API has been renamed to the IBM Quantum System Service API. As part of this change, the resource names and the prefixes of environment variables used by QRMI have been updated accordingly.

What changed#

Items

Deprecated names

New names

Resource type text

direct-access

ibm-quantum-system

Resource type (C)

QRMI_RESOURCE_TYPE_IBM_DIRECT_ACCESS

QRMI_RESOURCE_TYPE_IBM_QUANTUM_SYSTEM

Resource type (Python)

ResourceType.IBMDirectAccess

ResourceType.IBMQuantumSystem

Resource type (Rust)

ResourceType::IBMDirectAccess

ResourceType::IBMQuantumSystem

QuantumResource trait implementator (Rust)

qrmi::ibm::IBMDirectAccess

qrmi::ibm::IBMQuantumSystem

Environment variable prefixes

QRMI_IBM_DA_

QRMI_IBM_QS_

Transition period#

A transition period is in effect until July 2, 2026. During this period, both the legacy and the new resource names and environment variable prefixes are supported to ensure backward compatibility. After the transition period ends, support for the legacy names will be removed, and users are expected to have fully migrated to the new naming scheme.

How to migrate#

  1. Environment variables — Replace any environment variables prefixed with QRMI_IBM_DA_ with the equivalent QRMI_IBM_QS_ prefixed variables.

  2. Rust — Replace references to ResourceType::IBMDirectAccess and qrmi::ibm::IBMDirectAccess with ResourceType::IBMQuantumSystem and qrmi::ibm::IBMQuantumSystem respectively.

  3. Python — Replace references to ResourceType.IBMDirectAccess with ResourceType.IBMQuantumSystem.

  4. C — Replace QRMI_RESOURCE_TYPE_IBM_DIRECT_ACCESS with QRMI_RESOURCE_TYPE_IBM_QUANTUM_SYSTEM.

  5. Configuration files / resource type strings — Replace any occurrences of direct-access with ibm-quantum-system.

No functional behavior changes as a result of this rename; only names and identifiers are affected.