unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
362 stars 158 forks source link

Automatically generate package and add code tree #141

Closed nathanshammah closed 3 years ago

nathanshammah commented 4 years ago

Package Tree

A tree of the mitiq/mitiq package contents is added in the readme file. However, this was done "by hand". It may be nice to:

To do such thing, I think in linux one has the tree command. I haven't found one in Mac yet, but maybe there is one that is platform agnostic. However the tree could be updated only when there is a release, adding that info in the readme printout, to simplify code development.

Code Tree

It can be very useful (for sldes, etc.) and beautiful (to include an image of it in the documentation) to add a code tree. It does provide an intuitive way of how the library has developed in scope. I can copy the script from QuTiP's and pennylane.

rmlarose commented 3 years ago

I think this should be closed as #167 was closed. Please reopen if this isn't the case.