Qiskit
Add a save-to-file example in circuit visualization
URL, if applicable
https://docs.quantum.ibm.com/guides/visualize-circuits
Describe the new content you are requesting.
Our docs often promote utility size experiments. However, trying to draw a large scale circuit in a Jupyter Notebook often takes a long time even if it manages to complete without crashing. Not to mention the output is often unreadable. The more realistic way right now is to save the output to a file, which one can then zoom in and out as needed.
While the page does mention it's possible to save the output to a file, having a code example would encourage and normalize that behavior.
If this new content request is accepted, do you want to write the content?
I only want to review the material when it's finished
Hi @jyu00, I'd love to work on this issue! Adding a save-to-file example for circuit visualization sounds like a useful enhancement, especially for large-scale circuits. I can provide a code snippet demonstrating how to save the circuit output in different formats (text, matplotlib, LaTeX) for better readability and usability.
Please let me know if there are any specific requirements or guidelines to follow. Looking forward to contributing!
Hi @Gyan-max! Thanks for taking this on. As far as the guidelines for working in documentation, you can visit our style guide. We'll be happy to answer any questions along the way.
Hey @Gyan-max, thanks for your offer to help. After looking more at all of our issues yesterday, I think there is a more useful issue for you to work on for now: https://github.com/Qiskit/documentation/issues/154. We've been wanting to fix this for a long time because it helps keep our repository more organized. If you're interested in working on it, feel free to comment on that issue and I can assign you it.
Hi @Eric-Arellano, thanks for the update! I appreciate the opportunity to contribute. I'll take a look at issue #154 and see how I can help. Let me know if there are any specific details or priorities I should focus on.
Hi @jyu00, I’d like to work on this issue. Adding explicit examples for saving circuits to files seems very useful, and being able to zoom into details makes large circuits much more approachable for learners.
If this is still available, could you please confirm? I’ve reviewed the style guide , but let me know if there are any additional requirements to keep in mind. Also, would you prefer the example to live under “Control circuit drawings” or “Alternative renderers”?
Thanks!
Hi @Ahilan-Bucket, yes this is still available. @abbycross are there other pointers you can provide?