Add docs for generating LaTeX circuits
Open
Nobody has claimed this yet.
documentation :memo:
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 358
- Avg merge
- 1d 58m
- Merged PRs (30d)
- 4
Description
Currently the code to generate latex circuits is in pyquil, but there isn't documentation, and there isn't a nice frontend. (the current way of generating it is to call print(to_latex(p)).
It would be good to:
- Add docs
- Add some kind of frontend for jupyter notebooks that can render the circuits
- Add a method to Program, perhaps, to produce the latex code rather than having to import the function.
This might work: https://github.com/robjstan/tikzmagic
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the existing pyquil LaTeX circuit generation and the current print(to_latex(p)) usage. Clarify whether the work covers documentation, a Jupyter notebook frontend, the proposed Program method, or all three; completion should be defined for the selected scope, with the linked tikzmagic project as a reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100