Skip to content

[QI2-1872] Add BENCHMARKING to docs #42

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
oschusler merged 1 commit into from
May 22, 2026
Merged

[QI2-1872] Add BENCHMARKING to docs #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions docs/publish/meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ System 2300 publishes a state message to inform subscribers of its current state

| Key | Type | Value |
| --- | --- | --- |
| `state` | `str` | The current state of the system in all-capitals (i.e. `IDLE`, `EXECUTING`, `CALIBRATING`, `OFFLINE`) |
| `state` | `str` | The current state of the system in all-capitals (i.e. `IDLE`, `EXECUTING`, `BENCHMARKING`, `CALIBRATING`, `OFFLINE`) |
| `timestamp` | `float` | Timestamp of the instantiation of the message (return value of `time.time()`) |

The various states are defined as described below. The first state that applies from top to bottom, is used in the
published message.

* `OFFLINE`: 2300 is controlled manually or not reachable,
* `CALIBRATING`: 2300 is calibrating,
* `CALIBRATING`: 2300 is calibrating (involves actively changing values in the system),
* `BENCHMARKING`: 2300 is benchmarking (operations are read-only),
* `EXECUTING`: 2300 is initialized for execution and not yet terminated,
* `IDLE`: 2300 is not executing experiments and being calibrated.

Expand Down
5 changes: 3 additions & 2 deletions docs/request/meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ The backend will receive the cQASM string the same way it was provided by the us
## Get dynamic

Dynamic information is generated by 2300. This information can for example constitute calibration data like T1 and T2*.
This dynamic metadata fetched on a status change from `CALIBRATING`/`OFFLINE` to `IDLE` or on startup of 2200.
This dynamic metadata fetched on a status change from `BENCHMARKING`/`CALIBRATING`/`OFFLINE` to `IDLE` or on startup of
2200.

!!! info
The schemas for validation can be found in:
Expand All @@ -103,7 +104,7 @@ This dynamic metadata fetched on a status change from `CALIBRATING`/`OFFLINE` to
* `/schemas/<version>/QuantumHardwareFailureResponse.schema.json`

or the alternative failure response for version 2 and older:

* `/schemas/<version>/QuantumHardwareDataFailureResponse.schema.json`

### Get dynamic request payload
Expand Down
Loading