Skip to content

Commit f1370d1

Browse files
authored
Add deprecation note to README (#180)
* Add deprecation note to README * minor
1 parent dd38e99 commit f1370d1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

plugins/spank_qrmi/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# SPANK Plugin for QRMI
22

3+
> [!IMPORTANT]
4+
> **New Deprecations(Since 0.5.1)**
5+
>
6+
> The **IBM Direct Access API** has been renamed to the **IBM Quantum System API**.
7+
>
8+
> As part of this change, **the resource names and the prefixes of environment variables** used by QRMI have been updated accordingly.
9+
>
10+
> | Items | Deprecated names | New names |
11+
> | :--- | :--- | :--- |
12+
> | Resource type text | direct-access | ibm-quantum-system |
13+
> | Environment variable prefixes | QRMI_IBM_DA_ | QRMI_IBM_QS_ |
14+
>
15+
> A transition period will be 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 migrate fully to the new naming scheme.
16+
17+
318
This is a [SPANK plugin](https://slurm.schedmd.com/spank.html) that configures access to Quantum Resources from user jobs. It handles the acquisition and release of access to Quantum Resources and sets the necessary environment variables for executing Quantum workloads. The available Quantum Resources are specified in the qrmi_config.json file, which is managed by the administrator.
419

520
## Prerequisites

0 commit comments

Comments
 (0)