[CQT-369] Add CircuitBuilder user documentation#699
Open
rares1609 wants to merge 2 commits into
Open
Conversation
rares1609
requested review from
Copilot and
elenbaasc
and removed request for
Copilot
July 13, 2026 09:39
elenbaasc
changed the title
elenbaasc
reviewed
Jul 17, 2026
elenbaasc
left a comment
elenbaasc
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for the clear description!
Make sure to write each sentence on a new line and break sentences that are too long.
Comment on lines
+3
to
+4
| The `CircuitBuilder` is OpenSquirrel's programmatic API for constructing a circuit. It | ||
| offers an alternative to writing out a |
Collaborator
There was a problem hiding this comment.
Each sentence starts on a new line.
Suggested change
| The `CircuitBuilder` is OpenSquirrel's programmatic API for constructing a circuit. It | |
| offers an alternative to writing out a | |
| The `CircuitBuilder` is OpenSquirrel's programmatic API for constructing a circuit. | |
| It offers an alternative to writing out a |
Comment on lines
+10
to
+11
| naturally and easily expressed with code than as a static string, for instance when a | ||
| circuit has patterns that a `for` loop captures nicely. |
Collaborator
There was a problem hiding this comment.
It is much much broader than for loops. It should say that you basically have all programmatic tools at your disposal that are available in Python.
Comment on lines
+21
to
+29
| A builder is created by declaring the sizes of its qubit and (optionally) bit registers: | ||
|
|
||
| ```python | ||
| builder = CircuitBuilder(qubit_register_size=3, bit_register_size=2) | ||
| ``` | ||
|
|
||
| This reserves a qubit register `q` of size 3 and a bit register `b` of size 2. Qubits | ||
| and bits are always referred to by their integer index into these registers, | ||
| starting at `0`. |
Collaborator
There was a problem hiding this comment.
This is indeed the simplest way, but we should already mention (a reference and link to the section below) that a user can also define registers themselves and added these to the builder.
Comment on lines
+33
to
+35
| Once the builder is instantiated, instructions are added by calling the method that | ||
| carries the name of the instruction, passing the qubit and bit indices (and any | ||
| parameters for e.g. _parameterized gates_ ) as arguments: |
Collaborator
There was a problem hiding this comment.
Don't refer to gates as methods, that is confusing, just show how the instructions can be added, and add a reference link to the available instructions.
| raises an `AttributeError`, and passing the wrong number or type of arguments raises a | ||
| `TypeError`. | ||
|
|
||
| Instructions can also be appended directly with `add_instruction`, which accepts either |
Collaborator
There was a problem hiding this comment.
Suggested change
| Instructions can also be appended directly with `add_instruction`, which accepts either | |
| Instructions can also be appended with `add_instruction`, which accepts either |
| builder = CircuitBuilder(2) | ||
| builder.add_instruction(H(0)) | ||
| builder.add_instruction([H(1), CNOT(0, 1)]) | ||
| circuit = builder.to_circuit() |
Collaborator
There was a problem hiding this comment.
Suggested change
| circuit = builder.to_circuit() |
Comment on lines
+80
to
+83
| builder = CircuitBuilder(qubit_register_size=2) | ||
| builder.H(0) | ||
| builder.CNOT(0, 1) | ||
| circuit = builder.to_circuit() |
Collaborator
There was a problem hiding this comment.
Suggested change
| builder = CircuitBuilder(qubit_register_size=2) | |
| builder.H(0) | |
| builder.CNOT(0, 1) | |
| circuit = builder.to_circuit() | |
| builder = CircuitBuilder(qubit_register_size=2, bit_register_size=2) | |
| builder.add_instruction([H(0) CNOT(0, 1)]) | |
| builder.measure(1, 0).measure(0, 1) | |
| circuit = builder.to_circuit() |
Comment on lines
+89
to
+94
| version 3.0 | ||
|
|
||
| qubit[2] q | ||
|
|
||
| H q[0] | ||
| CNOT q[0], q[1] |
Collaborator
There was a problem hiding this comment.
Suggested change
| version 3.0 | |
| qubit[2] q | |
| H q[0] | |
| CNOT q[0], q[1] | |
| version 3.0 | |
| qubit[2] q | |
| bit[2] b | |
| H q[0] | |
| CNOT q[0], q[1] | |
| b[0] = measure q[1] | |
| b[1] = measure q[0] |
Comment on lines
+189
to
193
| ## Adding instructions | ||
|
|
||
|
|
||
|
|
||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Adding instructions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.