qec 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

qec-0.2.2.dist-info/METADATA

@@ -0,0 +1,146 @@
+Metadata-Version: 2.2
+Name: qec
+Version: 0.2.2
+Summary: Python Tools for Quantum Error Correction
+Author-email: Joschka Roffe <joschka@roffe.eu>
+License: MIT License
+        
+        Copyright (c) 2023 qec.Codes
+        
+        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.
+        
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ldpc
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scipy>=1.9.3
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+
+<h1>
+<p align="center">
+  <br>QEC
+</h1>
+  <p align="center">
+    Python Tools for Quantum Error Correction
+    <br />
+    <a href="https://qec.codes/">Website</a>
+    ·
+    <a href="#features">Features</a>
+    ·
+    <a href="#installation">Installation</a>
+    ·
+    <a href="#examples">Examples</a>
+  </p>
+</p>
+
+# Features
+
+## Code constructions and fundamental analysis
+We currently provide the construction methods for the stabilizer generators of the QEC code families below, along with optimized methods to obtain their fundamental properties. All the classes allow to:
+
+- obtain the physical qubit count
+- obtain the logical qubit count
+- calculate the exact code distance
+- estimate the minimum code distance
+- obtain a logical basis
+
+The classes (along with their extre methods) are:
+
+- Hyperprgarph Product (HGP) codes, with methods:
+  - construct the x and z stabiliser matrices from the seed codes
+  - obtain the canonical basis (work in progress)
+    
+- Calderbank-Shor-Steane (CSS) codes
+  - check that the seed codes satisfy the CSS criteria
+    
+- Stabiliser codes
+  - check that the input stabiliser matrix is valid
+
+## Circuit compilation
+Work in progress.
+
+# Installation 
+
+Simply do:
+```bash
+pip install qec
+```
+
+or obtain a local copy of the package by cloning it, then navigate into the created folder: 
+
+```bash
+git clone git@github.com:qec-codes/qec.git
+cd qec
+```
+
+Finally, install the package:
+
+```bash
+pip install -e .
+```
+
+You are all set! To import the package use:
+
+```python
+In  [1]: import qec
+
+In  [2]: qec.__version__
+Out [2]: '0.1.0'
+
+```
+
+# Examples
+
+In this example we are going to create the Steane code, and obtain its fundamental code properties. We start by initialising its seed matrices (the [7, 4, 3] Hamming code):
+```python
+In [1]: import numpy as np
+In [2]: from qec.code_constructions import CSSCode
+
+In [3]: hamming_code = np.array([[1, 0, 0, 1, 0, 1, 1],
+                                 [0, 1, 0, 1, 1, 0, 1],
+                                 [0, 0, 1, 0, 1, 1, 1]])
+```
+as the Steane code is part of the CSS code family, we can use the `CSSCode` class:
+
+```python
+In [4]: steane_code = CSSCode(x_stabilizer_matrix = hamming_code,
+                              z_stabilizer_matrix = hamming_code,
+                              name = "Steane")
+In [5]: print(steane_code)
+Out [6]: Steane Code: [[N=7, K=1, dx<=3, dz<=3]]
+```
+
+we can see that all the fundamental properties (N - physical qubit number, K - logical qubit number, dx - X distance, dz - Z distance) are pre-calculated for us. We can continue our analysis by taking a look at the x and z logical basis of the code: 
+
+```python
+In [7]: print(steane_code.x_logical_operator_basis.toarray())
+Out [8]: [[1 1 0 1 0 0 0]]
+In [9]: print(steane_code.z_logical_operator_basis.toarray())
+Out [10]: [[1 1 0 1 0 0 0]]
+```
+
+                              
+
+
+
+
+

qec-0.2.2.dist-info/RECORD

@@ -0,0 +1,18 @@
+qec/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qec/code_constructions/__init__.py,sha256=MWyNUCS5mYcDzjGr_nbr2-ifkJigRJIzsw7sQIQXDfM,119
+qec/code_constructions/css_code.py,sha256=nIaC24QhQwrmWQNhmX-X4TzlkmNAYoxN0feTdWjhswo,32376
+qec/code_constructions/hgp_code.py,sha256=VAKU2lfZnDXSmAk6xFZCYT5b0hbtXpEoQUw4qHFcaEk,10419
+qec/code_constructions/stabilizer_code.py,sha256=I5u8JKZu88ioC4E2nBJ-00xCmnL8nU6kdAvwYOfmNRk,22138
+qec/code_instances/__init__.py,sha256=z6jOPjekDIx0jgbRFThI95zUzLzjl9Dh89RBzxsT_BE,43
+qec/code_instances/five_qubit_code.py,sha256=ZHyusTEnnnmUv4QxPLXQSKbEQv2QOoBqn2V9N4SgrQE,2177
+qec/codetables_de/__init__.py,sha256=dQBgkBK_DlnI9OrOcfarM7HUbj9NKyO-9QSvItD2cyY,40
+qec/codetables_de/codetables_de.py,sha256=SdOaS7OTMt76uLa1GJXGydMTmwJdNwTDnQyD4SBQDIM,3626
+qec/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qec/utils/binary_pauli_utils.py,sha256=BSlngYDdRICu0aVu4u_m0bvLicohORyGxfk5eRER7TQ,13245
+qec/utils/codetables_de_utils.py,sha256=S1wcVGJkkASQQ5s71QAsYBmpyE-3xTb6UsvgMfQtuiw,9469
+qec/utils/sparse_binary_utils.py,sha256=Y9xfGKzOGFiVTyhb6iF6N7-5oMY6Ah9oLrnv8HhSBHA,1965
+qec-0.2.2.dist-info/LICENSE,sha256=1b_xwNz1znYBfEaCL6pN2gNBAn8pQIjDRs_UhDp1EJI,1066
+qec-0.2.2.dist-info/METADATA,sha256=Soh5GrdXcP861-epLVwGnKlk7tVrrtVVc1xKFTowbhA,4509
+qec-0.2.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+qec-0.2.2.dist-info/top_level.txt,sha256=d8l_7pJ5u9uWdviNp0FUK-j8VPZqywkDek7qa4NDank,4
+qec-0.2.2.dist-info/RECORD,,

qec/quantum_codes/__init__.py

@@ -1,2 +0,0 @@
-from qec.quantum_codes.five_qubit_code import FiveQubitCode
-from qec.quantum_codes.codetables_de import CodeTablesDE

qec/stabilizer_code/__init__.py

@@ -1 +0,0 @@
-from qec.stabilizer_code.stabilizer_code import StabilizerCode

qec/stabilizer_code/css_code.py

@@ -1,6 +0,0 @@
-from qec.stabilizer_code import StabilizerCode
-
-
-class CSSCode(StabilizerCode):
-    def __init__(self):
-        NotImplemented

qec-0.2.0.dist-info/METADATA

@@ -1,82 +0,0 @@
-Metadata-Version: 2.2
-Name: qec
-Version: 0.2.0
-Summary: Python Tools for Quantum Error Correction
-Author-email: Joschka Roffe <joschka@roffe.eu>
-License: MIT License
-        
-        Copyright (c) 2023 qec.Codes
-        
-        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.
-        
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ldpc
-Requires-Dist: numpy>=1.24.0
-Requires-Dist: scipy>=1.9.3
-Requires-Dist: requests
-Requires-Dist: beautifulsoup4
-
-<h1 align="center">QEC </h1>
-<h3 align="center"> Python Tools for Quantum Error Correction </h3>
-
-
-- Website: https://qec.codes/
-
-# Table of contents
-1. [Features](#features)
-2. [Installation](#installation)
-3. [Getting started](#getting-started)
-
-
-# Features
-
-Here will go the description of all our fancy features! 
-
-# Installation 
-
-Obtain a local copy of the package by cloning it, then navigate into the created folder: 
-
-```bash
-git clone git@github.com:qec-codes/qec.git
-cd qec
-```
-
-Finally, install the package:
-
-```bash
-pip install -e .
-```
-
-You are all set! To import the package use:
-
-```python
-In  [1]: import qec
-
-In  [2]: qec.__version__
-Out [2]: '0.1.0'
-
-```
-
-# Getting started
-
-A few simple examples 
-

qec-0.2.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-qec/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qec/quantum_codes/__init__.py,sha256=DQ1ztrq-vBpTyoehaMWOhals46tRj553Jmkq68bDk-E,117
-qec/quantum_codes/codetables_de.py,sha256=loBDBOK2cbDJ5moKmIx2MXg6e30XEPrEYau19bbDgac,3623
-qec/quantum_codes/five_qubit_code.py,sha256=0zrGLyIpfyKwYG7uL00yMcM5PdhQGF17_MiI2qTMhOk,2190
-qec/stabilizer_code/__init__.py,sha256=L5UMjHBlvfQBhkNlEZYSkyaHvNOcDHjc3oxYibMYHRk,63
-qec/stabilizer_code/css_code.py,sha256=8BotcCuWrbnxnbZ1ZIJDI1jgr6-ohq-haPolc59TcWw,127
-qec/stabilizer_code/stabilizer_code.py,sha256=_3oQwq2UNkPmP2R2qcsKTzYO4CLDvQdaiGxsN4_4r0I,22804
-qec/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qec/utils/binary_pauli_utils.py,sha256=FKxOMyEgUfSL1DF--8GUf4Nl6ytbK8Slyw7x2evhAac,13231
-qec/utils/codetables_de_utils.py,sha256=soCf3u2v-C5EYYMiL8Ta4H6UF8KhRCEkjxLd6qBJai4,9467
-qec/utils/sparse_binary_utils.py,sha256=Y9xfGKzOGFiVTyhb6iF6N7-5oMY6Ah9oLrnv8HhSBHA,1965
-qec-0.2.0.dist-info/LICENSE,sha256=1b_xwNz1znYBfEaCL6pN2gNBAn8pQIjDRs_UhDp1EJI,1066
-qec-0.2.0.dist-info/METADATA,sha256=DisbbTcVUey4dp5WelBc4aZeFcUkkwpsxRzMd44QncU,2367
-qec-0.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-qec-0.2.0.dist-info/top_level.txt,sha256=d8l_7pJ5u9uWdviNp0FUK-j8VPZqywkDek7qa4NDank,4
-qec-0.2.0.dist-info/RECORD,,