quarkcircuit 0.2.17__tar.gz → 0.3.0.dev2__tar.gz

{quarkcircuit-0.2.17 → quarkcircuit-0.3.0.dev2}/PKG-INFO

@@ -1,25 +1,14 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: quarkcircuit
-Version: 0.2.17
+Version: 0.3.0.dev2
 Summary: Construction, visualization, and transpilation of quantum circuits
 Author-email: Xiaoxiao Xiao <xiaoxx@baqis.ac.cn>
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: Chinese (Simplified)
-Classifier: Natural Language :: English
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Topic :: Scientific/Engineering :: Physics
+License-Expression: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: networkx
-Requires-Dist: quarkstudio
 
 # QuarkCircuit
 
@@ -49,7 +38,7 @@ pip install quarkcircuit
 
 ## First experience
 
-See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/quark/example/)
+See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/)
 
 ## License
 

{quarkcircuit-0.2.17 → quarkcircuit-0.3.0.dev2}/README.md

@@ -26,7 +26,7 @@ pip install quarkcircuit
 
 ## First experience
 
-See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/quark/example/)
+See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/)
 
 ## License
 

quarkcircuit-0.3.0.dev2/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quarkcircuit"
+version = "0.3.0dev2"
+authors = [
+  { name="Xiaoxiao Xiao", email="xiaoxx@baqis.ac.cn" }
+]
+description = "Construction, visualization, and transpilation of quantum circuits"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+dependencies = [
+    "numpy",
+    "scipy",
+    "networkx",
+]
+
+[tool.setuptools]
+packages = ["quark.circuit"]

{quarkcircuit-0.2.17 → quarkcircuit-0.3.0.dev2}/quark/circuit/__init__.py

@@ -44,6 +44,9 @@ from .matrix import *
 from .transpiler import Transpiler
 from .dag import dag2qc,qc2dag,draw_dag
 from .backend import Backend
-from .layout_helpers import Layout
-from .test_transpiler import call_quark_transpiler
-from .optimize_helpers import GateCompressor
+from .decompose import ThreeQubitGateDecompose
+from .layout import Layout
+from .routing import SabreRouting
+from .translate import TranslateToBasisGates
+from .optimize import GateCompressor
+from .test_transpiler import call_quark_transpiler

{quarkcircuit-0.2.17 → quarkcircuit-0.3.0.dev2}/quark/circuit/backend.py

@@ -20,6 +20,7 @@
 r"""
 This module contains the Backend class, which processes superconducting chip information into an undirected graph representation. It also supports the creation of custom undirected graphs to serve as virtual chips.
 """
+
 import networkx as nx
 import numpy as np
 from typing import Literal
@@ -55,9 +56,12 @@ class Backend:
             self.priority_qubits = self.chip_info['priority_qubits']
             self.qubits_with_attributes = self._collect_qubits_with_attributes()
             self.couplers_with_attributes = self._collect_couplers_with_attributes()
-        elif chip in ['Baihua','Haituo1','Dongling1','Dongling2','Yunmeng1']:
+        elif chip in ['Baihua','Dongling','Haituo','Yunmeng','Miaofeng',]:
             self.chip_name = chip
-            self.chip_info = load_chip_basic_info(chip)
+            try:
+                self.chip_info = load_chip_basic_info(chip)
+            except:
+                raise(ValueError(f'{chip} is under maintenance, configuration information is unavailable'))
             print('The last calibration time was',self.chip_info['calibration_time'])
             self.size = self.chip_info['size']
             self.priority_qubits = self.chip_info['priority_qubits']
@@ -85,7 +89,27 @@ class Backend:
         """
         return self.get_graph()
     
+    def edge_filtered_graph(self,thres = 0.6):
+        """Create a subgraph by filtering out edges with fidelity below a specified threshold.
+
+        Args:
+            thres (float, optional): The fidelity threshold. Defaults to 0.6.
+
+        Returns:
+            networkx.Graph: A new NetworkX graph object containing only edges with fidelity greater than or equal to the threshold.
+        """
+        def edge_filter(u,v):
+            return self.graph[u][v].get("fidelity") >= thres
+        subgraph_view = nx.subgraph_view(self.graph,filter_edge=edge_filter)
+        return nx.Graph(subgraph_view)
+    
     def _collect_qubits_with_attributes(self):
+        """Collect qubit indices and their associated attributes from chip information.
+
+        Returns:
+            list: A list of tuples, where each tuple contains a qubit index (int) and its attributes (dict)
+              extracted from self.chip_info['qubits_info']
+        """
         qubits_with_attributes = []
         for key in self.chip_info['qubits_info'].keys():
             qubit = int(key.split('Q')[1])
@@ -93,6 +117,12 @@ class Backend:
         return qubits_with_attributes
     
     def _collect_couplers_with_attributes(self):
+        """Collect coupler information including qubit indices and their associated attributes from chip information.
+
+        Returns:
+            list: A list of tuples, where each tuple contains two qubit indices (int, int) and the coupler attributes (dict)
+              extracted from self.chip_info['couplers_info'].
+        """
         couplers_with_attributes = []
         for key in self.chip_info['couplers_info'].keys():
             qubit1, qubit2 = self.chip_info['couplers_info'][key]['qubits_index']
@@ -110,8 +140,9 @@ class Backend:
         G.add_edges_from(self.couplers_with_attributes)
         return G
         
-    def draw(self,show_couplers_fidelity:bool = False, show_quibts_attributes:Literal['T1','T2','fidelity','frequency','']='', highlight_nodes:list = [],
-             save_svg_fname: str|None = None,show_qubits_label:bool=False,show_couplers_label:bool=False):
+    def draw(self,show_couplers_fidelity:bool = False, show_quibts_attributes:Literal['T1','T2','fidelity','frequency','']='', 
+             show_qubits_index:bool=False,show_couplers_index:bool=False,
+             highlight_nodes:list = [], save_svg_fname: str|None = None,):
         """Draw the chip layout.
     
         Args:
@@ -124,6 +155,8 @@ class Backend:
                 - 'frequancy': Display the frequency of qubits (in GHz).
                 - '': Display no attributes.
                 Defaults to ''.
+            show_qubits_index (bool, optional): Whether to display index for each qubit. Defaults to False.
+            show_couplers_index (bool, optional): Whether to display index for each coupler. Defaults to False.
             highlight_nodes (list, optional): A list of qubits to highlight. Defaults to an empty list [].
             save_svg_fname (str | None, optional): 
                 The filename for saving the drawing as an SVG. If None, the drawing will not be saved. 
@@ -141,8 +174,23 @@ class Backend:
         from matplotlib.colors import Normalize,LinearSegmentedColormap
         from matplotlib.cm import ScalarMappable 
 
+
         edge_fidelity = nx.get_edge_attributes(self.graph, 'fidelity') 
+        node_attributes = nx.get_node_attributes(self.graph,show_quibts_attributes)
         if show_couplers_fidelity:
+            if set(list(edge_fidelity.values())) == {None}:
+                print('The two-qubit gate fidelity is N/A now.')
+                is_edge_info_avaliable = False
+            else:
+                is_edge_info_avaliable = True
+        if show_quibts_attributes:
+            if set(list(node_attributes.values())) == {None}:
+                print('The qubit attributes is N/A now.')
+                is_node_info_avaliable = False
+            else:
+                is_node_info_avaliable = True            
+
+        if show_couplers_fidelity is True and is_edge_info_avaliable is True:
             min_fidelity = sorted(list(edge_fidelity.values()))[0]
             max_fidelity = sorted(list(edge_fidelity.values()))[-1]
             edge_norm = Normalize(vmin = min_fidelity, vmax = max_fidelity)
@@ -153,35 +201,36 @@ class Backend:
 
         edge_labels = {}
         for k,v in edge_fidelity.items():
-            fidelity = np.round(v, 3)
-            if show_couplers_fidelity:
-                if show_couplers_label:
+            if v == None:
+                fidelity = ''
+            else:
+                fidelity = np.round(v, 3)
+            if show_couplers_fidelity is True and is_edge_info_avaliable is True:
+                if show_couplers_index:
                     edge_labels[k] = self.graph.edges[k].get('index')
                 else:
                     edge_labels[k] = fidelity
             else:
                 edge_labels[k] = self.graph.edges[k].get('index')
 
-        if show_quibts_attributes != '':
-            node_attributes = nx.get_node_attributes(self.graph,show_quibts_attributes)
+        if show_quibts_attributes != '' and is_node_info_avaliable is True:
             min_attributes = sorted(list(node_attributes.values()))[0]
             max_attributes = sorted(list(node_attributes.values()))[-1]
             node_norm = Normalize(vmin = min_attributes, vmax = max_attributes)
             node_cmap = LinearSegmentedColormap.from_list('truncated_blues', plt.get_cmap('Blues')(np.linspace(0.31, 1.0, 1000))) #plt.get_cmap('Blues') 
-
             node_colors = [ScalarMappable(norm = node_norm, cmap = node_cmap).to_rgba(attribute) for attribute in node_attributes.values()]
             if show_quibts_attributes == 'fidelity':
-                if show_qubits_label:
+                if show_qubits_index:
                     node_labels = {node:node for node in self.graph.nodes()} 
                 else:
                     node_labels =  {node: np.round(attr, 3) for node, attr in node_attributes.items()} # 保留三位有效数字
             else:
-                if show_qubits_label:
+                if show_qubits_index:
                     node_labels = {node:node for node in self.graph.nodes()} 
                 else:    
                     node_labels =  {node: np.round(attr, 2) for node, attr in node_attributes.items()}  # 保留两位有效数字
             node_font_size = 8 
-            if show_couplers_fidelity:
+            if show_couplers_fidelity is True and is_edge_info_avaliable is True:
                 figsize = (15, 15)
             else:
                 figsize = (15, 13.5)
@@ -189,7 +238,7 @@ class Backend:
             node_colors = ['#083776' for node in self.graph.nodes()]
             node_labels = {node:node for node in self.graph.nodes()}   
             node_font_size = 10 
-            if show_couplers_fidelity:
+            if show_couplers_fidelity is True and is_edge_info_avaliable is True:
                 figsize = (15, 13.5)
             else:
                 figsize = (15, 13)
@@ -226,7 +275,7 @@ class Backend:
         nx.draw_networkx_labels(self.graph,pos,labels=node_labels,font_size=node_font_size, font_color='white')
         nx.draw_networkx_edge_labels(self.graph, pos, edge_labels=edge_labels,font_size=8, font_color='white',bbox=dict(facecolor='none', edgecolor='none'))
 
-        if show_quibts_attributes:
+        if show_quibts_attributes != '' and is_node_info_avaliable is True:
             if show_quibts_attributes == 'T1':
                 show_label = 'T1 ($\mu s$)'
             elif show_quibts_attributes == 'T2':
@@ -237,13 +286,13 @@ class Backend:
                 show_label = 'Frequency (GHz)'
             node_sm = ScalarMappable(cmap=node_cmap, norm=node_norm)
             node_sm.set_array(list(node_attributes.values()))  # 设置包含数据的数组
-            if show_couplers_fidelity:
+            if show_couplers_fidelity and is_edge_info_avaliable is True:
                 node_cbar = fig.colorbar(node_sm, ax=ax, orientation='horizontal',pad=0.07, fraction=0.03, aspect=25)
             else:
                 node_cbar = fig.colorbar(node_sm, ax=ax, orientation='horizontal',pad=0.001, fraction=0.0333, aspect=25)
             node_cbar.set_label(show_label)
 
-        if show_couplers_fidelity:  
+        if show_couplers_fidelity is True and is_edge_info_avaliable is True:
             edge_sm = ScalarMappable(cmap=edge_cmap, norm=edge_norm)# 创建颜色条
             edge_sm.set_array(list(edge_fidelity.values()))  # 设置包含数据的数组
             edge_cbar = fig.colorbar(edge_sm, ax=ax, orientation='horizontal',  pad=0.001, fraction=0.0333, aspect=25)# 调整颜色条大小和位置，放置在底部
@@ -252,7 +301,7 @@ class Backend:
         xlim = ax.get_xlim()
         ylim = ax.get_ylim()
         xpos = (xlim[0] + xlim[1]) / 2
-        ypos = ylim[1] * 0.75 
+        ypos = ylim[1] * 0.96
         ax.text(xpos, ypos, f'{self.chip_name}', va='center', ha='center', fontsize=24, fontweight='bold', color='k', family='serif')
 
         if save_svg_fname:

quarkcircuit-0.3.0.dev2/quark/circuit/basepasses.py

@@ -0,0 +1,41 @@
+# Copyright (c) 2024 XX Xiao
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+r"""
+This module contains the TranspilerPass class, an abstract base class for defining transpiler passes that transform or optimize quantum circuits. Subclasses must implement the run method to process QuantumCircuit objects.
+"""
+
+from abc import ABC, abstractmethod
+from .quantumcircuit import QuantumCircuit
+
+# 抽象基类
+class TranspilerPass(ABC):
+    """Abstract base class for defining transpiler passes that transform or optimize quantum circuits.
+    """
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    def run(self, qc:QuantumCircuit):
+        """Execute the transpiler pass on a quantum circuit.
+
+        Args:
+            qc (QuantumCircuit): The quantum circuit to be processed by this transpiler pass.
+        """
+        pass

{quarkcircuit-0.2.17 → quarkcircuit-0.3.0.dev2}/quark/circuit/dag.py

@@ -27,6 +27,7 @@ from .quantumcircuit import QuantumCircuit
 from .quantumcircuit_helpers import (
     one_qubit_gates_available,
     two_qubit_gates_available,
+    three_qubit_gates_available,
     one_qubit_parameter_gates_available,
     two_qubit_parameter_gates_available,
     functional_gates_available,
@@ -107,6 +108,8 @@ def dag2qc(dag: 'nx.DiGraph',nqubits: int, ncbits: int|None = None) -> 'QuantumC
             new.append((gate,qubits[0]))
         elif gate in two_qubit_gates_available.keys():
             new.append((gate,qubits[0],qubits[1]))
+        elif gate in three_qubit_gates_available.keys():
+            new.append((gate,qubits[0],qubits[1],qubits[2]))
         elif gate in one_qubit_parameter_gates_available.keys():
             params = dag.nodes[node]['params']
             new.append((gate,*params,qubits[0]))
@@ -120,7 +123,8 @@ def dag2qc(dag: 'nx.DiGraph',nqubits: int, ncbits: int|None = None) -> 'QuantumC
             elif gate == 'barrier':
                 new.append((gate,tuple(qubits)))
             elif gate == 'delay':
-                new.append((gate,tuple(qubits)))
+                duration = dag.nodes[node]['duration']
+                new.append((gate,duration,tuple(qubits)))
             elif gate == 'reset':
                 new.append((gate,qubits[0]))
                 

quarkcircuit-0.2.17/quark/circuit/decompose_helpers.py → quarkcircuit-0.3.0.dev2/quark/circuit/decompose.py

@@ -17,12 +17,32 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-r"""Some common decomposition methods for single-qubit and two-qubit gates."""
+r"""Some common decomposition methods for two-qubit and three-qubit gates."""
 
+import numpy as np
 from typing import Literal
 from .utils import u3_decompose
 from .matrix import u_mat
-import numpy as np
+from .quantumcircuit import QuantumCircuit
+from .basepasses import TranspilerPass
+
+def u_dot_u(u_info1: tuple, u_info2: tuple) -> tuple:
+    """Carry out u @ u and return a new u information
+
+    Args:
+        u_info1 (tuple): u gate information like ('u', 1.5707963267948966, 0.0, 3.141592653589793, 0)
+        u_info2 (tuple): u gate information like ('u', 1.5707963267948966, 0.0, 3.141592653589793, 0)
+
+    Returns:
+        tuple: A new u gate information
+    """
+    assert(u_info1[-1] == u_info2[-1])
+    u_mat1 = u_mat(*u_info1[1:-1])
+    u_mat2 = u_mat(*u_info2[1:-1])
+    
+    new_u = u_mat2 @ u_mat1
+    theta, phi, lamda, _ = u3_decompose(new_u)
+    return ('u', theta, phi, lamda, u_info1[-1])
 
 def h2u(qubit: int) -> tuple:
     """Convert H gate to U3 gate tuple.
@@ -346,20 +366,123 @@ def rzz_decompose(theta:float, qubit1:int, qubit2:int, convert_single_qubit_gate
         gates += cx_decompose(qubit1,qubit2,convert_single_qubit_gate_to_u,two_qubit_gate_basis)  
     return gates
 
-def u_dot_u(u_info1: tuple, u_info2: tuple) -> tuple:
-    """Carry out u @ u and return a new u information
+def ccx_decompose(control_qubit1: int, control_qubit2: int, target_qubit: int,):
+    """Decompose ccx gate. Reference: A biological sequence comparison algorithm using quantum computers
 
     Args:
-        u_info1 (tuple): u gate information like ('u', 1.5707963267948966, 0.0, 3.141592653589793, 0)
-        u_info2 (tuple): u gate information like ('u', 1.5707963267948966, 0.0, 3.141592653589793, 0)
+        control_qubit1 (int): The qubit used as the first control.
+        control_qubit2 (int): The qubit used as the second control.
+        target_qubit (int): The qubit targeted by the gate.
 
     Returns:
-        tuple: A new u gate information
+        list: A list of single- and two-qubit gates.
     """
-    assert(u_info1[-1] == u_info2[-1])
-    u_mat1 = u_mat(*u_info1[1:-1])
-    u_mat2 = u_mat(*u_info2[1:-1])
-    
-    new_u = u_mat2 @ u_mat1
-    theta, phi, lamda, _ = u3_decompose(new_u)
-    return ('u', theta, phi, lamda, u_info1[-1])
+    gates = [
+        ('h',target_qubit),
+        ('cx',control_qubit2,target_qubit),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('t',target_qubit),
+        ('cx',control_qubit2,target_qubit),
+        ('t',control_qubit2),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+        ('t',target_qubit),
+        ('t',control_qubit1),
+        ('tdg',control_qubit2),
+        ('h',target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+    ]
+    return gates
+
+def cswap_decompose(control_qubit1: int, control_qubit2: int, target_qubit: int,):
+    """Decompose cswap gate. Reference: http://threeplusone.com/gates
+
+    Args:
+        control_qubit1 (int): The qubit used as the first control.
+        control_qubit2 (int): The qubit used as the second control.
+        target_qubit (int): The qubit targeted by the gate.
+
+    Returns:
+        list: A list of single- and two-qubit gates.
+    """
+    gates = [
+        ('cx',target_qubit,control_qubit2),
+        ('h',target_qubit),
+        ('cx',control_qubit2,target_qubit),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('t',target_qubit),
+        ('cx',control_qubit2,target_qubit),
+        ('t',control_qubit2),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+        ('t',target_qubit),
+        ('t',control_qubit1),
+        ('tdg',control_qubit2),
+        ('h',target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+        ('cx',target_qubit,control_qubit2),
+    ]
+    return gates
+
+def ccz_decompose(control_qubit1: int, control_qubit2: int, target_qubit: int,):
+    """Decompose ccz gate. Reference: http://threeplusone.com/gates
+
+    Args:
+        control_qubit1 (int): The qubit used as the first control.
+        control_qubit2 (int): The qubit used as the second control.
+        target_qubit (int): The qubit targeted by the gate.
+
+    Returns:
+        list: A list of single- and two-qubit gates.
+    """
+    gates = [
+        ('cx',control_qubit2,target_qubit),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('t',target_qubit),
+        ('cx',control_qubit2,target_qubit),
+        ('t',control_qubit2),
+        ('tdg',target_qubit),
+        ('cx',control_qubit1,target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+        ('t',target_qubit),
+        ('t',control_qubit1),
+        ('tdg',control_qubit2),
+        ('h',target_qubit),
+        ('cx',control_qubit1,control_qubit2),
+        ('h',target_qubit)
+    ]
+    return gates
+
+class ThreeQubitGateDecompose(TranspilerPass):
+    """A transpiler pass that decomposes three-qubit gates into combinations of single- and two-qubit gates.
+    """
+    def __init__(self):
+        super().__init__()
+
+    def run(self,qc:QuantumCircuit):
+        """Decompose three-qubit gates in the quantum circuit into sequences of single- and two-qubit gates.
+
+        Args:
+            qc (QuantumCircuit): The quantum circuit to process.
+
+        Returns:
+            QuantumCircuit: A new quantum circuit with all three-qubit gates decomposed into single- and two-qubit gates.
+        """
+        new = []
+        for gate_info in qc.gates:
+            if gate_info[0] == 'ccx':
+                new += ccx_decompose(*gate_info[1:])
+            elif gate_info[0] == 'ccz':
+                new += ccz_decompose(*gate_info[1:])
+            elif gate_info[0] == 'cswap':
+                new += cswap_decompose(*gate_info[1:])
+            else:
+                new.append(gate_info)
+        new_qc = qc.deepcopy()
+        new_qc.gates = new
+        return new_qc