Intel_® Quantum SDK Extension for VS Code

The purpose of this extension is to create a visual representation of code for the C++ Intel_® Quantum Compiler in the form of a circuit board.

Note: See README-Dev.md for development instructions

Generate Circuit Board

Navigate to a valid json file that represents a quantum circuit board (Either test files or the output of the compiler). Then press the |0⟩ button on the right side of the tab bar. This will display a Webview containing the circuit board.

Export Circuit Board

Click on the tab with the generated circuit board to make it the active window. On the right side of the tab bar there will be an export button. This gives the user the option to export to an svg or png. The file will then appear as title.(chosen extension) in the directory opened in VS Code.

Note: Exported images will be light or dark based on your VS Code theme. To change your theme in VS Code press Ctrl + Shift + P and enter Color Theme.

Note: There is an issue where exported images do not contain Intel's custom font.

Understanding the json

IntelQuantumID: Tells the extension that this json represents a quantum circuit board

"IntelQuantumID": "Circuit-v1",

title: Sets the title of the circuit board

"title" : "Teleport |1⟩",

gateColorMethod: Chooses one of a few styles that describes how the gates should be colored

Note: Gate color methods include default, clifford, axis, and simple

"gateColorMethod": "simple",

numQbits: Defines the size of the y-axis and the number of qbits to display

"numQbits" : 3,

qbitNames: Defines the name of each qbit. The drawer will dynamically size the circuit to accommodate longer names. Empty strings will be converted to |0⟩.

"qbitNames" : [
	"example_0",
	"example_1",
	""
],

gates: Defines the gates that will be displayed on the circuit board. Gates require a name and a list of qbits to act upon. There is also an option to add attributes which will be displayed when the user hovers over that specific gate. Notice that some gates such as MeasZ have a custom gate icon.

"gates" : [
	{
		"name" : "Prep",
		"qubits" : [0]
	}, ...
	{
		"name" : "H",
		"qubits" : [1],
		"attributes" : ["Gate: Hadamard", "Test: 1"]
	},
	{
		"name" : "X",
		"qubits" : [1,2]
	}, ...
	{
		"name" : "Z",
		"qubits" : [0,2]
	}, ...
	{
		"name" : "MeasZ",
		"qubits" : [0]
	}, ...
]

Generate Histogram (Beta)

With a valid Intel Quantum Histogram Json file the user can generate a histogram to view the given state of a quantum system in graphical form.

Note: The compiler does not print the json required to use this feature so the user must create the json themselves and the layout of the json is subject to change

Note: This feature is still being developed and does not yet allow for exporting

Syntax Highlighting

This extension extends the list of keywords that are highlighted by VSCode to include grammar from the Intel_® Quantum SDK.

3rd Party Materials

License

Copyright (c) 2023 Intel Corporation. All rights reserved.

Licensed under the MIT license.