Merge branch 'main' into update-ci

qiskit-community · Aug 30, 2024 · 6a2f23a · 6a2f23a
2 parents 12852b5 + 3b62430
commit 6a2f23a
Show file tree

Hide file tree

Showing 19 changed files with 456 additions and 544 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx.ext.extlinks",
+    "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "nbsphinx",
     "matplotlib.sphinxext.plot_directive",

diff --git a/docs/how_tos/1-how-to-create-codes.ipynb b/docs/how_tos/1-how-to-create-codes.ipynb
diff --git a/docs/how_tos/2-how-to-work-with-shape-objects.ipynb b/docs/how_tos/2-how-to-work-with-shape-objects.ipynb
diff --git a/docs/tutorials/1-tutorial-example.ipynb b/docs/tutorials/1-tutorial-example.ipynb
diff --git a/docs/tutorials/QEC_Framework_IEEE_2022.ipynb b/docs/tutorials/QEC_Framework_IEEE_2022.ipynb
diff --git a/docs/tutorials/how-to-use-union-find.ipynb b/docs/tutorials/how-to-use-union-find.ipynb
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -7,3 +7,5 @@ nbsphinx
 ddt~=1.4.2
 matplotlib>=3.3.0
 black[jupyter]
+pandoc
+pylatexenc
diff --git a/src/qiskit_qec/codes/codebuilders/surface_code_builder.py b/src/qiskit_qec/codes/codebuilders/surface_code_builder.py
@@ -38,7 +38,7 @@ def __init__(
         dz: Optional[int] = None,
         ul_op: Optional[Pauli] = Pauli("Z"),
     ) -> None:
-        """Initializes a surface code builder
+        r"""Initializes a surface code builder
 
         If d is specified then dx and dz are ignored.
 

diff --git a/src/qiskit_qec/codes/codebuilders/triangular_color_code_builder.py b/src/qiskit_qec/codes/codebuilders/triangular_color_code_builder.py
@@ -26,7 +26,7 @@ class TriangularColorCodeBuilder(Builder):
 
     # pylint: disable=anomalous-backslash-in-string
     def __init__(self, d: int) -> None:
-        """Initializes a triangular color code builder
+        r"""Initializes a triangular color code builder
 
         Example:d=3
                         o

diff --git a/src/qiskit_qec/geometry/tiles/checkerboardtile.py b/src/qiskit_qec/geometry/tiles/checkerboardtile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class CheckerBoardTile(Tile):
-    """Checker Board Tile
+    r"""Checker Board Tile
 
     The diagram is as follows::
 
@@ -127,7 +127,7 @@ def __new__(
         operators=None,
         optype="pXZXZ",
     ) -> Shell:
-        """Creates a Checker Board Tile (Shell)
+        r"""Creates a Checker Board Tile (Shell)
 
         ::
 

diff --git a/src/qiskit_qec/geometry/tiles/diagonalbartile.py b/src/qiskit_qec/geometry/tiles/diagonalbartile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class DiagonalBarTile(Tile):
-    """Diagonal Bar Tile
+    r"""Diagonal Bar Tile
     The diagram is as follows::
 
         q0           q1     q1           q2
@@ -112,7 +112,7 @@ def __new__(
         operators=None,
         optype="pXXZZXX",
     ) -> Shell:
-        """Diagonal Hour Glass Tile
+        r"""Diagonal Hour Glass Tile
 
         The diagram is as follows::
 

diff --git a/src/qiskit_qec/geometry/tiles/hexagontile.py b/src/qiskit_qec/geometry/tiles/hexagontile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class HexagonTile(Tile):
-    """Hexagon Tile
+    r"""Hexagon Tile
 
     Weight 6 operators (0,1,2)::
 
@@ -273,7 +273,7 @@ def __new__(
         operators=None,
         optype="cZ-aXX",
     ) -> Shell:
-        """Hexagon Tile
+        r"""Hexagon Tile
 
         Tile::
 

diff --git a/src/qiskit_qec/geometry/tiles/octasquaretile.py b/src/qiskit_qec/geometry/tiles/octasquaretile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class OctaSquareTile(Tile):
-    """Octa-Square Tile
+    r"""Octa-Square Tile
 
     The tile has the following structure::
 

diff --git a/src/qiskit_qec/geometry/tiles/squarediamondtile.py b/src/qiskit_qec/geometry/tiles/squarediamondtile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class SquareDiamondTile(Tile):
-    """Square Diamond Tile (Square or non-Rotated orientation)
+    r"""Square Diamond Tile (Square or non-Rotated orientation)
 
     The follow labelling is used::
 
@@ -104,7 +104,7 @@ def __new__(
         operators=None,
         optype="pXZXZ",
     ) -> Shell:
-        """Square Diamond Tile
+        r"""Square Diamond Tile
 
         The following labels are used::
 

diff --git a/src/qiskit_qec/linear/symplectic.py b/src/qiskit_qec/linear/symplectic.py
@@ -2178,3 +2178,10 @@ def _normailzer_group(matrix):
     center_, hyper1, hyper2 = _symplectic_gram_schmidt(matrix, [], [])
 
     return _normalizer_group_preserve(center_, hyper1, hyper2)
+
+
+def _extend_symplectic(matrix: np.array, extend: int):
+    n = matrix.shape[1] // 2
+    ext_part = np.zeros(shape=(matrix.shape[0], extend), dtype=matrix.dtype)
+    ext_matrix = np.hstack((matrix[:, 0:n], ext_part, matrix[:, n:], ext_part))
+    return ext_matrix