Support common notations in circuit_to_latex_using_qcircuit - PR for Issue #4685 #7151
Conversation
…leaned up other files
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7151 +/- ##
==========================================
+ Coverage 97.88% 98.12% +0.24%
==========================================
Files 1085 1093 +8
Lines 95184 95596 +412
==========================================
+ Hits 93174 93808 +634
+ Misses 2010 1788 -222 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I apologize for how long it's taking to resolve formatting issues. |
No need for apologies at all! What would make it easier to catch format issues these earlier? I know from experience that waiting for CI checks to tell me about niggling issues becomes frustrating pretty quickly. Are there ways of making the contribution process easier on people? |
|
I see, you're right, running a tool before pushing a commit would speed up this process a lot. I found the /benchmarks and /check directories in Cirq, and I'm assuming the ./check/all script runs all the checks for formatting. Is there any step that I'm missing? I really appreciate the response @mhucka. |
|
@NikolaiLong what is the operating system you're using? |
|
@mhucka I'm on Windows using PowerShell (Administrator). |
|
Ah, hmm, that's probably why they are not working as expected. They were written with the assumption of Linux/MacOS/Unix systems (c.f. https://quantumai.google/cirq/dev/development). The only thing that comes to mind right now is to try the Windows Subsystem for Linux (WSL). I haven't used it myself, but reading about it, it's supposed to provide a Bash shell, so maybe those scripts will run there. Would the WSL be an option? I don't know what versions of Windows support it or what other impliications it has. |
|
Yes! I have WSL installed on my machine already. I'll use it for the next issue I work on, that'll probably fix this problem. Thanks for helping get to the bottom of this @mhucka! |
NikolaiLong
changed the title
|
@NikolaiLong very sorry for the delay reviewing this. 
|
mhucka
added this to the 2025-T4: Improve capabilities for circuit visualization milestone
There was a problem hiding this comment.
Thank you for working on this!
It's really great to provide an example file and rendered output. Would you be open to adding a couple more test cases? The issue #4685 only shows a particular example (namely, the particular case the OP was concerned about), but IMHO the issue is a little broader. This PR is an opportunity to cover a support slightly more operations. Especially welcome would be:
- gates H, X, Y, Z gates
- measurement operator
Examples of these gates can be seen in the Qcircuit tutorial and in the Cirq docs about basic circuits & gates. The gates in particular have some similarities, which suggests that the implementation in this PR could be done by looking for commonalities and writing generalized code, rather than very specific code for each individual case.
There was a problem hiding this comment.
Sure, I can add more test cases and cover these additional gates. I'll get working on that soon!
| # def test_pdf_custom_gates(): | ||
| # # test for proper rendering of failing latex formats in a pdf | ||
| # q0, q1, q2 = cirq.LineQubit.range(3) | ||
|
|
||
| # # custom gate with a control for zero and one | ||
| # custom_gate = cirq.X.controlled(2, control_values=(0, 1)) | ||
|
|
||
| # circuit = cirq.Circuit( | ||
| # custom_gate(q0, q1, q2), | ||
| # custom_gate(q2, q0, q1), | ||
| # custom_gate(q1, q2, q0), | ||
| # cirq.SWAP(q0, q1), | ||
| # cirq.SWAP(q1, q2), | ||
| # ) | ||
|
|
||
| # pdf_kwargs = { | ||
| # 'compiler': 'latexmk', | ||
| # 'compiler_args': ['-pdf', '-f', '-pdflatex=xelatex', '-quiet'], | ||
| # } | ||
|
|
||
| # remove = ['aux', 'fdb_latexmk', 'fls', 'log'] | ||
|
|
||
| # # This test was facing errors due to technical issues in qcuircuit_pdf.py | ||
| # # that are out of scope of my issue (4685) | ||
| # # It will remain commented out until a resolution is found, | ||
| # # or until it is realized that this test is not necessary | ||
|
|
||
| # pdf.circuit_to_pdf_using_qcircuit_via_tex( | ||
| # circuit, | ||
| # "./cirq-core/cirq/contrib/qcircuit/pdf_test_files/test", | ||
| # pdf_kwargs, | ||
| # None, | ||
| # remove | ||
| # ) |
There was a problem hiding this comment.
I'm not sure why this commented-out code is in the file. We don't typically want to leave commented-out code in the final versions of things, so it would be best to remove this.
There was a problem hiding this comment.
Okay, I will remove this - I was trying to test PDF output, but the required packages aren't included in the virtual environment set up, so the tests would not be able to run on everyone's machine.
|
I think this needs a bit more time to converge. As a |
pavoljuhas
added
priority/after-1.5
mhucka
removed this from the 2025-T4: Improve capabilities for circuit visualization milestone
PR for: #4685