Binder MPL test

qiskit/visualization/circuit_visualization.py

@@ -137,7 +137,6 @@ def circuit_drawer(circuit,
             when the ``output`` kwarg is set to use the ``mpl`` backend. It
             will be silently ignored with all other outputs.
         initial_state (bool): Optional. Adds ``|0>`` in the beginning of the wire.
-            Only used by the ``text``, ``latex`` and ``latex_source`` outputs.
             Default: ``False``.
         cregbundle (bool): Optional. If set True bundle classical registers. Not used by
             the ``matplotlib`` output. Default: ``False``.
@@ -321,6 +320,7 @@ def circuit_drawer(circuit,
                                            justify=justify,
                                            idle_wires=idle_wires,
                                            with_layout=with_layout,
+                                           initial_state=initial_state,
                                            fold=fold,
                                            ax=ax)
     else:
@@ -624,6 +624,7 @@ def _matplotlib_circuit_drawer(circuit,
                                justify=None,
                                idle_wires=True,
                                with_layout=True,
+                               initial_state=False,
                                fold=None,
                                ax=None):
     """Draw a quantum circuit based on matplotlib.
@@ -644,6 +645,8 @@ def _matplotlib_circuit_drawer(circuit,
         idle_wires (bool): Include idle wires. Default is True.
         with_layout (bool): Include layout information, with labels on the physical
             layout. Default: True.
+        initial_state (bool): Optional. Adds ``|0>`` in the beginning of the line.
+            Default: ``False``.
         fold (int): amount ops allowed before folding. Default is 25.
         ax (matplotlib.axes.Axes): An optional Axes object to be used for
             the visualization output. If none is specified a new matplotlib
@@ -670,5 +673,5 @@ def _matplotlib_circuit_drawer(circuit,
     qcd = _matplotlib.MatplotlibDrawer(qregs, cregs, ops, scale=scale, style=style,
                                        plot_barriers=plot_barriers,
                                        reverse_bits=reverse_bits, layout=layout,
-                                       fold=fold, ax=ax)
+                                       initial_state=initial_state, fold=fold, ax=ax)
     return qcd.draw(filename)

qiskit/visualization/matplotlib.py

@@ -104,7 +104,8 @@ def get_index(self):
 class MatplotlibDrawer:
     def __init__(self, qregs, cregs, ops,
                  scale=1.0, style=None, plot_barriers=True,
-                 reverse_bits=False, layout=None, fold=25, ax=None):
+                 reverse_bits=False, layout=None, initial_state=False,
+                 fold=25, ax=None):
 
         if not HAS_MATPLOTLIB:
             raise ImportError('The class MatplotlibDrawer needs matplotlib. '
@@ -139,6 +140,7 @@ def __init__(self, qregs, cregs, ops,
         self.plot_barriers = plot_barriers
         self.reverse_bits = reverse_bits
         self.layout = layout
+        self.initial_state = initial_state
         if style:
             if isinstance(style, dict):
                 self._style.set_style(style)
@@ -542,19 +544,26 @@ def _fix_double_script(label):
             return ' '.join(words)
 
         len_longest_label = 0
+        if self.initial_state:
+            initial_qbit = ' |0>'
+            initial_cbit = ' 0 '
+        else:
+            initial_qbit = ''
+            initial_cbit = ''
+
         # quantum register
         for ii, reg in enumerate(self._qreg):
             if len(self._qreg) > 1:
                 if self.layout is None:
-                    label = '${{{name}}}_{{{index}}}$'.format(name=reg.register.name,
-                                                              index=reg.index)
+                    label = '${{{name}}}_{{{index}}}$'.format(
+                        name=reg.register.name, index=reg.index) + initial_qbit
                 else:
                     label = '${{{name}}}_{{{index}}} \\mapsto {{{physical}}}$'.format(
                         name=self.layout[reg.index].register.name,
                         index=self.layout[reg.index].index,
-                        physical=reg.index)
+                        physical=reg.index) + initial_qbit
             else:
-                label = '${name}$'.format(name=reg.register.name)
+                label = '${name}$'.format(name=reg.register.name) + initial_qbit
 
             label = _fix_double_script(label)
             if len(label) > len_longest_label:
@@ -578,7 +587,7 @@ def _fix_double_script(label):
                     self._creg, n_creg)):
                 pos = y_off - idx
                 if self._style.bundle:
-                    label = '${}$'.format(reg.register.name)
+                    label = '${}$'.format(reg.register.name) + initial_cbit
                     label = _fix_double_script(label)
                     self._creg_dict[ii] = {
                         'y': pos,
@@ -589,7 +598,7 @@ def _fix_double_script(label):
                     if not (not nreg or reg.register != nreg.register):
                         continue
                 else:
-                    label = '${}_{{{}}}$'.format(reg.register.name, reg.index)
+                    label = '${}_{{{}}}$'.format(reg.register.name, reg.index) + initial_cbit
                     label = _fix_double_script(label)
                     self._creg_dict[ii] = {
                         'y': pos,
@@ -646,7 +655,7 @@ def _draw_regs_sub(self, n_fold, feedline_l=False, feedline_r=False):
                              clip_on=True,
                              zorder=PORDER_TEXT)
             self.ax.text(self.x_offset - 0.2, y, this_creg['label'], ha='right', va='center',
-                         fontsize=1.5 * self._style.fs,
+                         fontsize=1.25 * self._style.fs,
                          color=self._style.tc,
                          clip_on=True,
                          zorder=PORDER_TEXT)

releasenotes/notes/initial-state-all-drawers-7c9de960ac4bdd7a.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    A new kwarg, ``initial_state`` has been added to the
+    :func:`qiskit.visualization.circuit_drawer` function and the
+    :class:`~qiskit.circuit.QuantumCircuit` method
+    :meth:`~qiskit.circuit.QuantumCircuit.draw`. When set to ``True`` the
+    initial state will now be included in circuit visualizations for all drawers.
+    For example:
+
+    .. jupyter-execute::
+
+        from qiskit import QuantumCircuit
+
+        circuit = QuantumCircuit(2)
+        circuit.measure_all()
+        circuit.draw(output='mpl', initial_state=True)

test/binder/mpl/test_circuit_matplotlib_drawer.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+import unittest
+
+from qiskit import QuantumCircuit, QuantumRegister
+from qiskit import visualization
+
+
+class TestMatplotlibDrawer(unittest.TestCase):
+
+    def test_long_name(self):
+        """Test to see that long register names can be seen completely
+        As reported in #2605
+        """
+
+        # add a register with a very long name
+        qr = QuantumRegister(4, 'veryLongQuantumRegisterName')
+        # add another to make sure adjustments are made based on longest
+        qrr = QuantumRegister(1, 'q0')
+        circuit = QuantumCircuit(qr, qrr)
+
+        # check gates are shifted over accordingly
+        circuit.h(qr)
+        circuit.h(qr)
+        circuit.h(qr)
+
+        visualization.circuit_drawer(circuit, output='mpl', filename='long_name.png')
+
+
+if __name__ == '__main__':
+    unittest.main(verbosity=1)

test/binder/mpl_tester.ipynb

@@ -0,0 +1,44 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%run 'mpl/test_circuit_matplotlib_drawer.py'"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%run -i 'results.py'\n",
+    "results"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

test/binder/results.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2020.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+import os
+
+CWD = os.path.dirname(os.path.abspath(__file__))
+
+
+class Results:
+    def __init__(self, namelist):
+        self.namelist = namelist
+
+    def _repr_html_(self):
+        ret = "<table>"
+        ret += '<tr><td>Filename</td><td>Result</td><td>Reference</td></tr>'
+        for name in self.namelist:
+            ret += '<tr>'
+            ret += '<td>' + name + '</td>'
+            ret += '<td><img src="' + name + '"</td>'
+            reference = os.path.join('mpl', 'references', name)
+            if os.path.exists(os.path.join(CWD, reference)):
+                ret += '<td><img src="' + reference + '"</td>'
+            else:
+                ret += '<td style="text-align:center">' \
+                       'Add <a download="%s" href="%s">this image</a> ' \
+                       'to %s and push</td>' % (name, reference, reference)
+            ret += '</tr>'
+        ret += "</table>"
+        return ret
+
+
+namelist = []
+for file in os.listdir(CWD):
+    if file.endswith(".png"):
+        namelist.append(file)
+results = Results(namelist)