Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 0 additions & 7 deletions docs/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,13 @@ for these messages and should be inherited from for every relevant message.
| --- | --- | --- |
| `command` | `str` | A string identifying the function to be executed. |
| `payload` | `dict` | Arguments for the function to be executed. Presence of this key-value pair depends on the specific command. |
| `version` | `str` | String containing the version number of the message format. This allows modification of the interface in a backwards compatible manner. The version will adhere to the [semantic versioning rules](<https://semver.org/>). Presently we are still using a beta numbering (`0.y.z`). |

```json title="base_request.json" linenums="1"
{
"command": "execute",
"payload": {
// optional
},
"version": "0.2.0"
}
```

Expand All @@ -39,7 +37,6 @@ for these messages and should be inherited from for every relevant message.
| `status` | `str` | "success" or "failure", depending on whether the command executed successfully. |
| `payload` | `dict` | The return value(s) of the executed command (presence of this key-value pair then depends on the specific command). |
| `payload.error_msg` | `str` | If `"status" == "failure"`: a string describing the failure in more detail. |
| `version` | `str` | String containing the version number of the message format. This allows modification of the interface in a backwards compatible manner. The version will adhere to the [semantic versioning rules](<https://semver.org/>). Presently we are still using a beta numbering (`0.y.z`). |

#### Base reply success

Expand All @@ -49,7 +46,6 @@ for these messages and should be inherited from for every relevant message.
"payload": {
// optional
},
"version": "0.2.0"
}
```

Expand All @@ -61,7 +57,6 @@ for these messages and should be inherited from for every relevant message.
"payload": {
"error_msg": "Lorem ipsum"
},
"version": "0.2.0"
}
```

Expand All @@ -88,7 +83,6 @@ inherited from for every relevant message.
"payload": {
// optional
},
"version": "0.2.0"
}
```

Expand All @@ -105,6 +99,5 @@ inherited from for every relevant message.
"payload": {
// optional
},
"version": "0.2.0"
}
```
1 change: 0 additions & 1 deletion docs/publish/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,5 @@ published message.
"state": "IDLE",
"timestamp": 1690061619.610174
},
"version": "0.2.0"
}
```
2 changes: 0 additions & 2 deletions docs/request/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ implementations of 2300 might impose different requirements. These will be descr
"include_raw_data": true,
"number_of_shots": 4
},
"version": "0.2.0"
}
```

Expand Down Expand Up @@ -70,6 +69,5 @@ implementations of 2300 might impose different requirements. These will be descr
"000"
]
},
"version": "0.2.0"
}
```
4 changes: 0 additions & 4 deletions docs/request/locking.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ This message does not require any additional information in the payload section.
{
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
"command": "initialize",
"version": "0.2.0"
}
```

Expand All @@ -38,7 +37,6 @@ This message does not require any additional information in the payload section.
{
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
"status": "success",
"version": "0.2.0"
}
```

Expand All @@ -64,7 +62,6 @@ This message does not require any additional information in the payload section.
{
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
"command": "terminate",
"version": "0.2.0"
}
```

Expand All @@ -78,6 +75,5 @@ This message does not require any additional information in the payload section.
{
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
"status": "success",
"version": "0.2.0"
}
```
14 changes: 8 additions & 6 deletions docs/request/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This message does not require any additional information in the payload section.
```json title="get_static_request.json" linenums="1"
{
"command": "get_static",
"version": "0.2.0"
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
}
```

Expand All @@ -36,6 +36,7 @@ This message does not require any additional information in the payload section.
| Key | Type | Value |
| --- | --- | --- |
| `nqubits` | `int` | The number of qubits |
| `protocol_version` | `int` | The version of this protocol that is being used |
| `topology` | `array[tuple]` | List of the edges between the various qubits |
| `name` | `str` | Name of the system |
| `pgs` | `array[str]` | Supported primitive gates set of the system. Gate names as described `instructions` (bottom of file) in [QuIS](https://github.com/QuTech-Delft/QuIS/blob/develop/quis/quis.json) |
Expand All @@ -50,6 +51,7 @@ This message does not require any additional information in the payload section.
"status": "success",
"payload": {
"nqubits": 5,
"protocol_version": 3,
"topology": [
[0, 2],
[1, 2],
Expand All @@ -73,7 +75,7 @@ This message does not require any additional information in the payload section.
]
}
},
"version": "0.2.0"
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
}
```

Expand Down Expand Up @@ -113,7 +115,7 @@ This message does not require any additional information in the payload section.
```json title="get_dynamic_request.json" linenums="1"
{
"command": "get_dynamic",
"version": "0.2.0"
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
}
```

Expand All @@ -137,10 +139,10 @@ necessary panels in the dashboard or alerts can also reference values for indivi
```json title="get_dynamic_reply.json" linenums="1"
{
"status": "success",
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
"payload": {
"fridge_temperature_in_mk": 8.4
},
"version": "0.2.0"
}
```

Expand All @@ -162,7 +164,7 @@ qi_fridge_temperature_in_mk 8.4
"q1": 0.988
}
},
"version": "0.2.0"
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
}
```

Expand All @@ -186,7 +188,7 @@ qi_t1{qubit=q1} 0.988
}
}
},
"version": "0.2.0"
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
}
```

Expand Down