Text based Circuit Rendering Module

[gadhvirushiraj]

TextRenderer + BaseRenderer + Tests + Documentation

GSOC'24 Project - QuTiP: Enhanced Quantum Circuit Diagrams | Phase#2 PR

Major Task Outline

TextRenderer ✅

• Single Qubit Gate Rendering
• Multi-Qubit Gate Rendering
• Custom Gate Rendering
• Measurement Rendering
• Customization Options

Tests ✅

• MatRenderer Test Cases
• TextRenderer Test Cases

BaseRenderer ✅

Documentation ✅

[BoxiLi]

There is one thing that I forgot last time, the public API should be added to the apidoc https://github.com/qutip/qutip-qip/tree/master/doc/source/apidoc, when you add doc.

[BoxiLi]

This is just a first quick review. A more detailed one will follow.

You can also add the test for matplotlib here, should be fine. There should also be one test for the circuit.draw() interface, making sure that the API is working properly.

The tex renderer should also be renamed to match the convention.

[gadhvirushiraj]

@BoxiLi
I've updated the circuit.py file. The QubitCircuit object now uses matplotlib as the default representation (if matplotlib is available); otherwise, it falls back to text-based rendering. I've also removed the unnecessary LaTeX hooks for Jupyter Notebooks. Currently, I've added a bool option to the draw function for saving in the respective format, didn't find a better approach for integrating the save functionality.

[BoxiLi]

Yeah the interface of circuit.draw looks good.

[BoxiLi]

Sorry for the delay and thank you very much for the fix @gadhvirushiraj ! It looks all good. Merge.

Lets see how the tutorials run!