Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify circuit drawer methods #1055

Merged
merged 3 commits into from
Oct 9, 2018
Merged

Unify circuit drawer methods #1055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c70f848
Unify circuit drawer methods
mtreinish Oct 8, 2018
624b5d7
Add changelog
mtreinish Oct 8, 2018
61b8899
Fix docstring lint
mtreinish Oct 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,20 @@ The format is based on `Keep a Changelog`_.
Changed
-------

Deprecated
----------
- ``plot_circuit()``, ``latex_circuit_drawer()``, ``generate_latex_source()``,
and ``matplotlib_circuit_drawer()`` from qiskit.tools.visualization are
deprecated. Instead the ``circuit_drawer()`` function from the same module
should be used. (#1055)
- The current default output of ``circuit_drawer()`` (using latex and falling
back on python) is deprecated and will be changed in the future. (#1055)
Fixed
-----
- Fixed horizontal spacing when drawing barriers before CCNOT gates in latex
circuit plots (#1051)


`0.6.0`_ - 2018-10-04
=====================

Expand Down
141 changes: 134 additions & 7 deletions qiskit/tools/visualization/_circuit_visualization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from io import StringIO
from itertools import groupby, zip_longest
from math import fmod, isclose, ceil
import warnings

import numpy as np
from PIL import Image, ImageChops
Expand All @@ -48,6 +49,9 @@ def plot_circuit(circuit,
"""Plot and show circuit (opens new window, cannot inline in Jupyter)
Defaults to an overcomplete basis, in order to not alter gates.
"""
warnings.warn('The plot_circuit() function is deprecated and will be '
'removed in the future. Instead use circuit_drawer() with '
'the `interactive` flag set true', DeprecationWarning)
im = circuit_drawer(circuit, basis=basis, scale=scale, style=style)
if im:
im.show()
Expand All @@ -58,7 +62,9 @@ def circuit_drawer(circuit,
"cx,cy,cz,ch,crz,cu1,cu3,swap,ccx,cswap",
scale=0.7,
filename=None,
style=None):
style=None,
output=None,
interactive=False):
"""Draw a quantum circuit, via 2 methods (try 1st, if unsuccessful, 2nd):

1. latex: high-quality images, but heavy external software dependencies
Expand All @@ -72,14 +78,48 @@ def circuit_drawer(circuit,
scale (float): scale of image to draw (shrink if < 1)
filename (str): file path to save image to
style (dict or str): dictionary of style or file name of style file
output (str): Select the output method to use for drawing the circuit.
Valid choices are `latex`, `latex_source`, `python`. Note if one is
not specified it will use latex and if that fails fallback to
python. However this behavior is deprecated and in a future release
the default will change.
interactive (bool): when set true show the circuit in a new window
(cannot inline in Jupyter). Note when used with the latex_source
output type this has no effect

Returns:
PIL.Image: an in-memory representation of the circuit diagram

Raises:
VisualizationError: when an invalid output method is selected
"""
try:
return latex_circuit_drawer(circuit, basis, scale, filename, style)
except (OSError, subprocess.CalledProcessError):
return matplotlib_circuit_drawer(circuit, basis, scale, filename, style)

im = None
if not output:
warnings.warn('The current behavior for the default output will change'
' in a future release. Instead of trying latex and '
'falling back to python on failure it will just use '
'python by default', DeprecationWarning)
try:
im = _latex_circuit_drawer(circuit, basis, scale, filename, style)
except (OSError, subprocess.CalledProcessError):
im = _matplotlib_circuit_drawer(circuit, basis, scale, filename,
style)
else:
if output not in ['latex', 'latex_source', 'python']:
raise VisualizationError(
'Invalid output type %s selected. The only valid choices are '
'latex, latex_source, and python' % output)
if output == 'latex':
im = _latex_circuit_drawer(circuit, basis, scale, filename, style)
elif output == 'latex_source':
return _generate_latex_source(circuit, basis, scale, filename, style)
elif output == 'python':
im = _matplotlib_circuit_drawer(circuit, basis, scale, filename,
style)
if im and interactive:
im.show()
return im


# -----------------------------------------------------------------------------
Expand Down Expand Up @@ -252,6 +292,7 @@ def qx_color_scheme():
# -----------------------------------------------------------------------------
# latex_circuit_drawer
# -----------------------------------------------------------------------------

def latex_circuit_drawer(circuit,
basis="id,u0,u1,u2,u3,x,y,z,h,s,sdg,t,tdg,rx,ry,rz,"
"cx,cy,cz,ch,crz,cu1,cu3,swap,ccx,cswap",
Expand All @@ -262,6 +303,39 @@ def latex_circuit_drawer(circuit,

Requires version >=2.6.0 of the qcircuit LaTeX package.

Args:
circuit (QuantumCircuit): a quantum circuit
basis (str): comma separated list of gates
scale (float): scaling factor
filename (str): file path to save image to
style (dict or str): dictionary of style or file name of style file

Returns:
PIL.Image: an in-memory representation of the circuit diagram

Raises:
OSError: usually indicates that ```pdflatex``` or ```pdftocairo``` is
missing.
CalledProcessError: usually points errors during diagram creation.
"""
warnings.warn('The latex_circuit_drawer() function is deprecated and will '
'be removed in a future release. Instead use the '
'circuit_drawer() function with the `output` kwarg set to '
'`latex`.', DeprecationWarning)
return _latex_circuit_drawer(circuit, basis=basis, scale=scale,
filename=filename, style=style)


def _latex_circuit_drawer(circuit,
basis="id,u0,u1,u2,u3,x,y,z,h,s,sdg,t,tdg,rx,ry,rz,"
"cx,cy,cz,ch,crz,cu1,cu3,swap,ccx,cswap",
scale=0.7,
filename=None,
style=None):
"""Draw a quantum circuit based on latex (Qcircuit package)

Requires version >=2.6.0 of the qcircuit LaTeX package.

Args:
circuit (QuantumCircuit): a quantum circuit
basis (str): comma separated list of gates
Expand All @@ -280,8 +354,8 @@ def latex_circuit_drawer(circuit,
tmpfilename = 'circuit'
with tempfile.TemporaryDirectory() as tmpdirname:
tmppath = os.path.join(tmpdirname, tmpfilename + '.tex')
generate_latex_source(circuit, filename=tmppath, basis=basis,
scale=scale, style=style)
_generate_latex_source(circuit, filename=tmppath, basis=basis,
scale=scale, style=style)
im = None
try:

Expand Down Expand Up @@ -340,6 +414,30 @@ def generate_latex_source(circuit, filename=None,
scale=0.7, style=None):
"""Convert QuantumCircuit to LaTeX string.

Args:
circuit (QuantumCircuit): input circuit
scale (float): image scaling
filename (str): optional filename to write latex
basis (str): optional comma-separated list of gate names
style (dict or str): dictionary of style or file name of style file

Returns:
str: Latex string appropriate for writing to file.
"""
warnings.warn('The generate_latex_source() function is deprecated and will'
' be removed in a future release. Instead use the '
'circuit_drawer() function with the `output` kwarg set to '
'`latex_source`.', DeprecationWarning)
return _generate_latex_source(circuit, filename=filename, basis=basis,
scale=scale, style=style)


def _generate_latex_source(circuit, filename=None,
basis="id,u0,u1,u2,u3,x,y,z,h,s,sdg,t,tdg,rx,ry,rz,"
"cx,cy,cz,ch,crz,cu1,cu3,swap,ccx,cswap",
scale=0.7, style=None):
"""Convert QuantumCircuit to LaTeX string.

Args:
circuit (QuantumCircuit): input circuit
scale (float): image scaling
Expand Down Expand Up @@ -1377,6 +1475,35 @@ def matplotlib_circuit_drawer(circuit,
If `%matplotlib inline` is invoked in a Jupyter notebook, it visualizes a circuit inline.
We recommend `%config InlineBackend.figure_format = 'svg'` for the inline visualization.

Args:
circuit (QuantumCircuit): a quantum circuit
basis (str): comma separated list of gates
scale (float): scaling factor
filename (str): file path to save image to
style (dict or str): dictionary of style or file name of style file

Returns:
PIL.Image: an in-memory representation of the circuit diagram
"""
warnings.warn('The matplotlib_circuit_drawer() function is deprecated and '
'will be removed in a future release. Instead use the '
'circuit_drawer() function with the `output` kwarg set to '
'`python`.', DeprecationWarning)
return _matplotlib_circuit_drawer(circuit, basis=basis, scale=scale,
filename=filename, style=style)


def _matplotlib_circuit_drawer(circuit,
basis='id,u0,u1,u2,u3,x,y,z,h,s,sdg,t,tdg,rx,'
'ry,rz,cx,cy,cz,ch,crz,cu1,cu3,swap,ccx,'
'cswap',
scale=0.7,
filename=None,
style=None):
"""Draw a quantum circuit based on matplotlib.
If `%matplotlib inline` is invoked in a Jupyter notebook, it visualizes a circuit inline.
We recommend `%config InlineBackend.figure_format = 'svg'` for the inline visualization.

Args:
circuit (QuantumCircuit): a quantum circuit
basis (str): comma separated list of gates
Expand Down