Skip to content

Add deprecation note to README #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ohtanim merged 2 commits into from
Mar 27, 2026
Merged

Add deprecation note to README #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab9d325
Add deprecation note to README
ohtanim Mar 27, 2026
39b1442
minor
ohtanim Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions plugins/spank_qrmi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# SPANK Plugin for QRMI

> [!IMPORTANT]
> **New Deprecations(Since 0.5.1)**
>
> The **IBM Direct Access API** has been renamed to the **IBM Quantum System API**.
>
> As part of this change, **the resource names and the prefixes of environment variables** used by QRMI have been updated accordingly.
>
> | Items | Deprecated names | New names |
> | :--- | :--- | :--- |
> | Resource type text | direct-access | ibm-quantum-system |
> | Environment variable prefixes | QRMI_IBM_DA_ | QRMI_IBM_QS_ |
>
> 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.


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.

## Prerequisites
Expand Down
Loading