Basic Circuit Editor for .qsc files #2187
Conversation
…tarks/circuit-viz-build
ScottCarda-MS
changed the title
ScottCarda-MS
requested review from
billti,
minestarks,
idavis,
swernli and
DmitryVasilevsky
as code owners
…e file and render an empty circuit.
| gate: "|0〉", | ||
| targets: [{ qId: 0, type: RegisterType.Qubit }], | ||
| }, | ||
| ResetX: { |
There was a problem hiding this comment.
I don't think |1> is ResetX. 0 and 1 are in the Z basis. I would have thought ResetX maps to |+>?
There was a problem hiding this comment.
Oh good point. ResetX does mean something else. I've renamed this to ResetOne.
There was a problem hiding this comment.
Actually, I realized last night I was wrong here. If a qubit starts in the |0> state, then applying an X does indeed put it into the |1> state. Applying an H puts it into what is commonly called the |+> state which is along the X basis of measurement, which I was getting confused with. Sorry!
vscode/package.json
Outdated
| "displayName": "Quantum Circuit", | ||
| "selector": [ | ||
| { | ||
| "filenamePattern": "*.qviz" |
There was a problem hiding this comment.
We should decide if this is the file extension we want to ship with.
Also, you should add a file icon for whatever extension we add (search on "icon" in this file for existing icons).
There was a problem hiding this comment.
Changed to .qsc extension as per discussion. I set the icon to the same as the .qs files. I think we should come up with a unique icon for the circuits in the near future though.
ScottCarda-MS
changed the title
| /** Array of qubit resources. */ | ||
| qubits: Qubit[]; | ||
| operations: Operation[]; | ||
| operations: Operation[][]; |
There was a problem hiding this comment.
In general, I dislike array-of-array as a type... for one, multi-dimensional arrays are just annoying to code against. But also, there's usually an intermediate type in there you're hiding, that deserves its own type for clarity.
What does an Operation[] represent? A column, I assume? You can wrap that it its own object:
interface Column {
operations: Operation[];
}This also makes the type more future-proof in case you ever want to add a new property to the column itself (like, what if columns could have annotations? I don't know, just making stuff up)
And then this property here can become
columns: Column[];Now when I read the type, it's easier to understand what Operation[] is, rather than try to keep in my head what each layer of the two-dimensional array corresponds to.
| @@ -52,15 +71,17 @@ export interface Operation { | |||
| /** Formatted gate arguments to be displayed. */ | |||
| displayArgs?: string; | |||
| /** Nested operations within this operation. */ | |||
| children?: Operation[]; | |||
| children?: Operation[][]; | |||
| /** Number of columns to span. */ | |||
There was a problem hiding this comment.
Consider saying in the comment what the default is if this property is omitted. 1?
| /** Whether gate is an adjoint operation. */ | ||
| isAdjoint: boolean; | ||
| isAdjoint?: boolean; | ||
| /** Control registers the gate acts on. */ | ||
| controls?: Register[]; | ||
| /** Target registers the gate acts on. */ |
There was a problem hiding this comment.
For readability, can you put targets at the top below the other required properties? This is the most important property buried beneath all the optional ones.
This PR adds a custom editor view in the VS Code extension for files with the .qsc extension. The editor makes use of the same library code that is used to draw circuit diagrams elsewhere in the VS Code extension. The editor provides basic drag-and-drop editing of circuits with a simple gate set, including the ability to have controlled gates, and gates with arguments.
The circuit files are included in Q# projects and can be called into from Q# as if they were Q# operations. This is done by generating Q# files for circuit files when compiling.