diff --git a/docs/publish/meta.md b/docs/publish/meta.md index 470320d..4d88367 100644 --- a/docs/publish/meta.md +++ b/docs/publish/meta.md @@ -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. diff --git a/docs/request/meta.md b/docs/request/meta.md index 12e025b..fdbc3a0 100644 --- a/docs/request/meta.md +++ b/docs/request/meta.md @@ -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: @@ -103,7 +104,7 @@ This dynamic metadata fetched on a status change from `CALIBRATING`/`OFFLINE` to * `/schemas//QuantumHardwareFailureResponse.schema.json` or the alternative failure response for version 2 and older: - + * `/schemas//QuantumHardwareDataFailureResponse.schema.json` ### Get dynamic request payload