Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

circuit drawing in documentation #98

Closed
jaygambetta opened this issue Feb 15, 2019 · 5 comments · Fixed by #226
Closed

circuit drawing in documentation #98

jaygambetta opened this issue Feb 15, 2019 · 5 comments · Fixed by #226
Assignees
@derivation
Labels
documentation Something is not clear or error in description

Comments

@jaygambetta
Copy link
Member

jaygambetta commented Feb 15, 2019 •
edited
Loading

How should we be drawing the circuits in the documentation

Currently it is from the text.

image

@ajavadia do you want it latex or matplotlib?
@jaygambetta jaygambetta added the documentation Something is not clear or error in description label Feb 15, 2019
@derivation
Copy link
Contributor

Are there plans to have QuantumCircuit.draw() able to stylize circuits in the same way as the Quantum Composer? Might that roadmap inform this choice?

@ajavadia
Copy link
Member

matplotlib might look better in the docs. it does have a style field as well that you can play with. i also like the professional look of the latex one, but it is currently buggy in some parts.

@jaygambetta
Copy link
Member Author

jaygambetta commented Feb 15, 2019 •
edited
Loading

I think so with matplotlib. @derivation we dont have an interactive on the roadmap yet but i agree it would be cool to have. There is an issue to build one in terra. For now i think we should use the matplotlib version.

@derivation
Copy link
Contributor

I'm going through the doc, updating the circuit diagrams as necessary. I'm starting with the global Getting Started material.

@derivation derivation mentioned this issue Feb 19, 2019
Merged
jaygambetta referenced this issue Feb 20, 2019
@derivation @jaygambetta
circuit draw style as mpl in docs/getting_started.rst (#128)
354bf8b 
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes #88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2caf.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes #97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes #107 and fixes #95

* added Contributin to Qiskit

fixes Qiskit/qiskit#112

* remove Aer install instructions

fixes Qiskit/qiskit#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit#98

* adopting the term of art 'quantum cloud services'
derivation referenced this issue Feb 20, 2019
@derivation
fixes image reference in getting_started.rst (#130)
572a32e 
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes #88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2caf.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes #97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes #107 and fixes #95

* added Contributin to Qiskit

fixes Qiskit/qiskit#112

* remove Aer install instructions

fixes Qiskit/qiskit#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit#98

* adopting the term of art 'quantum cloud services'

* getting_started references wrong circuit drawing PNG file

Fixes Qiskit/qiskit#129
derivation referenced this issue Feb 21, 2019
@derivation
Add instructions on how to create a provider (#131)
8c6a5db 
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes #88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2caf.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes #97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes #107 and fixes #95

* added Contributin to Qiskit

fixes Qiskit/qiskit#112

* remove Aer install instructions

fixes Qiskit/qiskit#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit#98

* adopting the term of art 'quantum cloud services'

* getting_started references wrong circuit drawing PNG file

Fixes Qiskit/qiskit#129

* Add instructions on how to create a provider

fixes  Qiskit/qiskit#123

* fix a typo in contributing_to_qiskit.rst

* update instructions on how to create a provider

addressing review by @yaelbh

* ipython3 to python code blocks
@derivation derivation mentioned this issue Feb 21, 2019
Merged
jaygambetta referenced this issue Feb 23, 2019
@derivation @jaygambetta
matplotlib circuit drawings in Terra doc (#137)
5888334 
* Continues to address Qiskit/qiskit#98

Focused on quantum_circuits.rst

* fix lint error

* fix lint errors
@t-imamichi
Copy link
Member

FYI. There is a tutorial of matplotlib circuit drawer. https://github.com/Qiskit/qiskit-tutorials/blob/master/to_sort/circuit_drawing.ipynb

@derivation derivation mentioned this issue May 2, 2019
Merged
derivation added a commit that referenced this issue May 2, 2019
@derivation
closes #98 (#226)
af7d13d 
circuit drawings in documentation use mpl
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this issue Aug 11, 2023
@derivation @jaygambetta
circuit draw style as mpl in docs/getting_started.rst (Qiskit/qiskit-…
32d246f 
…metapackage#128)

* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95

* added Contributin to Qiskit

fixes Qiskit/qiskit-metapackage#112

* remove Aer install instructions

fixes Qiskit/qiskit-metapackage#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit-metapackage#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit-metapackage#98

* adopting the term of art 'quantum cloud services'
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this issue Aug 11, 2023
@derivation
fixes image reference in getting_started.rst (Qiskit/qiskit-metapacka…
099d576 
…ge#130)

* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95

* added Contributin to Qiskit

fixes Qiskit/qiskit-metapackage#112

* remove Aer install instructions

fixes Qiskit/qiskit-metapackage#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit-metapackage#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit-metapackage#98

* adopting the term of art 'quantum cloud services'

* getting_started references wrong circuit drawing PNG file

Fixes Qiskit/qiskit-metapackage#129
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this issue Aug 11, 2023
@derivation
Add instructions on how to create a provider (Qiskit/qiskit-metapacka…
dfcba8f 
…ge#131)

* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95

* added Contributin to Qiskit

fixes Qiskit/qiskit-metapackage#112

* remove Aer install instructions

fixes Qiskit/qiskit-metapackage#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit-metapackage#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit-metapackage#98

* adopting the term of art 'quantum cloud services'

* getting_started references wrong circuit drawing PNG file

Fixes Qiskit/qiskit-metapackage#129

* Add instructions on how to create a provider

fixes  Qiskit/qiskit-metapackage#123

* fix a typo in contributing_to_qiskit.rst

* update instructions on how to create a provider

addressing review by @yaelbh

* ipython3 to python code blocks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@derivation derivation

Labels
documentation Something is not clear or error in description
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

circuit drawing in documentation
4 participants
@derivation @ajavadia @jaygambetta @t-imamichi