codedistance 0.0.2__tar.gz → 0.0.3__tar.gz

{codedistance-0.0.2 → codedistance-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codedistance
-Version: 0.0.2
+Version: 0.0.3
 Summary: Code and Circuit Distance Algorithms.
 License: GNUv3
 License-File: LICENSE
@@ -68,14 +68,6 @@ The main inputs to these functions are:
 
 These are described in more detail below.
 
-# Running Datasets from the Paper
-The datasets used in the paper are saved in the examples subfolder. 
-As each dataset may have many codes/circuits, the recommended way to run these is via the batch script runTest.py (also within the examples subfolder).
-The distance-finding results for the data set are saved in a text file within the examples/results folder.
-For example, to find distances of the non-CSS codetables dataset using the QDistEvol function, open a terminal window, navigate/change directory to the examples folder then run the following command via a terminal:
-
-python3 runTest.py --dataset codeTables --datafile QECC_sample.txt --method QDistEvol
-
 # Input Formats for Codes and Circuits
 The form of the input code/circuit depends on the function called. 
 
@@ -85,11 +77,21 @@ To indicate that H is in two block form, set tB=2. The tB notation is used throu
 
 L can optionally be excluded or set to None. This would be the case for classical codes or where we have not yet calculated a logical basis. For instance, where H is a two-block matrix representing a non-CSS code, a logical basis is calculated if required by the distance-finding method.
 
-For CSScodeDistance the code is represented the binary matrices Hx and Hz representing the X and Z checks respectively. These do not need to be full rank, and can be an over-complete generating set.
+For CSScodeDistance binary matrices Hx and Hz are used to represent the X and Z checks respectively. These do not need to be full rank, and can be an over-complete generating set.
 The component input to this function can be set to 'Z' to find Z-distance (the default setting) or 'X' for X-distance.
 
 For circuitDistance, the circuit qc should be provided in Stim format.
 
+# Output Format
+The three main functions return a python dictionary with the following fields:
+- n: length of the code/circuit
+- k: number of logicals/observables
+- d: minimum distance estimate
+- L: example of a logical or codeword with weight d in binary form
+- T: the number of trials conducted (eg for QDistRnd or syndrome decoder methods)
+- R: the number of trials which gave the distance estimate d
+- progress: status information output by the method during processing
+
 # Distance-Finding Methods
 The distance-finding methods available in the package are as follows:
 
@@ -129,6 +131,15 @@ The distance-finding methods available in the package are as follows:
 - qubitserfMM: wrapper to C library implementation of https://github.com/qubitserfed/Qubitserf
 - MeetMiddleMW: python implementation of algorithm set out in https://github.com/qiskit-community/qiskit-qec/blob/main/docs/tutorials/QEC_Framework_IEEE_2022.ipynb
 
+
+# Running Datasets from the Paper
+The datasets used in the paper are saved in the examples subfolder https://github.com/m-webster/codeDistancePYPI/tree/main/examples. 
+As each dataset may have many codes/circuits, the recommended way to run these is via the batch script runTest.py (also within the examples subfolder).
+The distance-finding results for the data set are saved in a text file within the examples/results folder.
+For example, to find distances of the non-CSS codetables dataset using the QDistEvol function, open a terminal window, navigate/change directory to the examples folder then run the following command via a terminal:
+
+python3 runTest.py --dataset codeTables --datafile QECC_sample.txt --method QDistEvol
+
 # Parameters for Distance-Finding Methods
 Here we lay out the main parameter settings used for various distance-finding methods:
 

{codedistance-0.0.2 → codedistance-0.0.3}/README.md

@@ -31,14 +31,6 @@ The main inputs to these functions are:
 
 These are described in more detail below.
 
-# Running Datasets from the Paper
-The datasets used in the paper are saved in the examples subfolder. 
-As each dataset may have many codes/circuits, the recommended way to run these is via the batch script runTest.py (also within the examples subfolder).
-The distance-finding results for the data set are saved in a text file within the examples/results folder.
-For example, to find distances of the non-CSS codetables dataset using the QDistEvol function, open a terminal window, navigate/change directory to the examples folder then run the following command via a terminal:
-
-python3 runTest.py --dataset codeTables --datafile QECC_sample.txt --method QDistEvol
-
 # Input Formats for Codes and Circuits
 The form of the input code/circuit depends on the function called. 
 
@@ -48,11 +40,21 @@ To indicate that H is in two block form, set tB=2. The tB notation is used throu
 
 L can optionally be excluded or set to None. This would be the case for classical codes or where we have not yet calculated a logical basis. For instance, where H is a two-block matrix representing a non-CSS code, a logical basis is calculated if required by the distance-finding method.
 
-For CSScodeDistance the code is represented the binary matrices Hx and Hz representing the X and Z checks respectively. These do not need to be full rank, and can be an over-complete generating set.
+For CSScodeDistance binary matrices Hx and Hz are used to represent the X and Z checks respectively. These do not need to be full rank, and can be an over-complete generating set.
 The component input to this function can be set to 'Z' to find Z-distance (the default setting) or 'X' for X-distance.
 
 For circuitDistance, the circuit qc should be provided in Stim format.
 
+# Output Format
+The three main functions return a python dictionary with the following fields:
+- n: length of the code/circuit
+- k: number of logicals/observables
+- d: minimum distance estimate
+- L: example of a logical or codeword with weight d in binary form
+- T: the number of trials conducted (eg for QDistRnd or syndrome decoder methods)
+- R: the number of trials which gave the distance estimate d
+- progress: status information output by the method during processing
+
 # Distance-Finding Methods
 The distance-finding methods available in the package are as follows:
 
@@ -92,6 +94,15 @@ The distance-finding methods available in the package are as follows:
 - qubitserfMM: wrapper to C library implementation of https://github.com/qubitserfed/Qubitserf
 - MeetMiddleMW: python implementation of algorithm set out in https://github.com/qiskit-community/qiskit-qec/blob/main/docs/tutorials/QEC_Framework_IEEE_2022.ipynb
 
+
+# Running Datasets from the Paper
+The datasets used in the paper are saved in the examples subfolder https://github.com/m-webster/codeDistancePYPI/tree/main/examples. 
+As each dataset may have many codes/circuits, the recommended way to run these is via the batch script runTest.py (also within the examples subfolder).
+The distance-finding results for the data set are saved in a text file within the examples/results folder.
+For example, to find distances of the non-CSS codetables dataset using the QDistEvol function, open a terminal window, navigate/change directory to the examples folder then run the following command via a terminal:
+
+python3 runTest.py --dataset codeTables --datafile QECC_sample.txt --method QDistEvol
+
 # Parameters for Distance-Finding Methods
 Here we lay out the main parameter settings used for various distance-finding methods:
 

{codedistance-0.0.2 → codedistance-0.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "codedistance"
-version = "0.0.2"
+version = "0.0.3"
 description = "Code and Circuit Distance Algorithms."
 license = "GNUv3"
 authors = ["Mark Webster <mark.acacia@gmail.com>","Abraham Jacob <abraham.jacob.17@ucl.ac.uk>","Oscar Higgott <oscarhiggott@google.com>"]