qruise qpu add
Add a new QPU to QruiseOS.
Syntax¶
Description¶
The qruise qpu add command initialises the QruiseOS infrastructure for the specified QPU. After running this command, QruiseOS is ready to accept data from flows and experiments for the QPU.
Arguments¶
| Argument | Description |
|---|---|
NAME |
Name of the QPU to add. Must conform to QPU naming rules. Required. |
Options¶
| Option | Description |
|---|---|
-f, --description-file |
Location of the QPU description file. Must be a Markdown text file. |
--help |
Show a help message and exit. |
Examples¶
Adding a QPU to QruiseOS¶
To add a QPU to QruiseOS using the CLI, make sure you have an identity file with tenant administrator permissions set up on your machine, as described here. For instance, if you're using the default identity for this purpose, adding a QPU named test-qpu is as simple as running the following command:
On the other hand, if you have a dedicated identity file for running administrative tasks, e.g. tenant-admin, you can specify it using the --identity flag:
A successful creation of a QPU will be signified by a message printed to the terminal:
Adding a QPU with description¶
It's also possible to add a QPU description during its creation using the --description-file or -f flag. This flag accepts a path to a text file containing a Markdown description of the QPU. For instance, if the description of your quantum device can be found in /home/qruise/test-qpu-description.md, you can instruct the CLI to use it by running the following:
qruise --identity tenant-admin qpu add test-qpu --description-file /home/qruise/test-qpu-description.md
You can use either relative or absolute paths, depending on which form is more convenient.