codedistance 0.0.4__tar.gz → 0.0.5__tar.gz

codedistance-0.0.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mark Alan Webster, Abraham Jacob, Oscar Higgott
+
+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.

{codedistance-0.0.4 → codedistance-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codedistance
-Version: 0.0.4
+Version: 0.0.5
 Summary: Code and Circuit Distance Algorithms.
 License: GNUv3
 License-File: LICENSE
@@ -42,7 +42,13 @@ Distance algorithms for classical codes, quantum codes and quantum circuits
 Mark Webster, Abe Jacob and Oscar Higgott
 
 # Installation
-To install the python library, use pip install codedistance
+To install the python library, use 
+
+    pip install codedistance
+
+If you wish to make changes to the source code or run the examples from the package, you can also download the codebase from the [github page](https://github.com/m-webster/codeDistancePYPI), create a virtual environment, navigate to the local copy of the codebase and run:
+
+    pip install -e .
 
 Certain distance-finding algorithms require installation of external packages:
 
@@ -52,6 +58,8 @@ Certain distance-finding algorithms require installation of external packages:
 4. CLISATDist: requies a SAT solver binary on the system path - by default this is cashwmaxsatcoreplus which runs only on Unix systems and is available from https://maxsat-evaluations.github.io/2023
 5. qubitserfBZ and qubitserfMM: requires compiliation of the C library from https://github.com/qubitserfed/Qubitserf. By default, this results in an executable called "interface". This binary should be renamed qubitserf and be accessible on the system path
 
+To compile on a Windows machine we recommend using Cygwin with the packages listed  [here](https://www.codefull.net/2015/12/essential-cygwin-development-packages/).
+
 
 # Main Distance-Finding Functions
 The package finds distances of classical codes, CSS quantum codes, non-CSS quantum codes and quantum circuits. 
@@ -136,7 +144,7 @@ As each dataset may have many codes/circuits, the recommended way to run these i
 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
+    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.4 → codedistance-0.0.5}/README.md

@@ -5,7 +5,13 @@ Distance algorithms for classical codes, quantum codes and quantum circuits
 Mark Webster, Abe Jacob and Oscar Higgott
 
 # Installation
-To install the python library, use pip install codedistance
+To install the python library, use 
+
+    pip install codedistance
+
+If you wish to make changes to the source code or run the examples from the package, you can also download the codebase from the [github page](https://github.com/m-webster/codeDistancePYPI), create a virtual environment, navigate to the local copy of the codebase and run:
+
+    pip install -e .
 
 Certain distance-finding algorithms require installation of external packages:
 
@@ -15,6 +21,8 @@ Certain distance-finding algorithms require installation of external packages:
 4. CLISATDist: requies a SAT solver binary on the system path - by default this is cashwmaxsatcoreplus which runs only on Unix systems and is available from https://maxsat-evaluations.github.io/2023
 5. qubitserfBZ and qubitserfMM: requires compiliation of the C library from https://github.com/qubitserfed/Qubitserf. By default, this results in an executable called "interface". This binary should be renamed qubitserf and be accessible on the system path
 
+To compile on a Windows machine we recommend using Cygwin with the packages listed  [here](https://www.codefull.net/2015/12/essential-cygwin-development-packages/).
+
 
 # Main Distance-Finding Functions
 The package finds distances of classical codes, CSS quantum codes, non-CSS quantum codes and quantum circuits. 
@@ -99,7 +107,7 @@ As each dataset may have many codes/circuits, the recommended way to run these i
 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
+    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.4/codedistance/distance.py → codedistance-0.0.5/codedistance/distance-old.py

@@ -34,7 +34,6 @@ def codeDistance(H,L=None,tB=1,method='QDistRndMW',params={},seed=None):
         L = Z2Mat(L)
     r,n = H.shape
     res = {'n':n//tB,'k':0,'d': 0, 'L': Z2MatZeros(n), 'progress': '', 'R': 1,'T': 1}
-    params['method'] = method
     wDict = None
     if method in {'magmaMinWeight', 'magmaMinWord','magmaWEDist'}:
         res['d'],res['L'],res['progress'] = magmaDist(H,L,tB,params)