Euler computations

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,4 +22,4 @@ A clear and concise description of what you expected to happen.
 - Related module versions if applicable: [e.g. numpy=2.2.0]
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -13,4 +13,4 @@ A clear and concise description of what the problem is.
 A clear and concise description of what you want to happen.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -13,4 +13,4 @@ Then, please fill in below:
 
 **Description of the change:**
 
-**Related issue:**
+**Related issue:**

.github/workflows/doc.yml

@@ -29,3 +29,15 @@ jobs:
         with:
           name: html-docs
           path: docs/build
+
+  lint-text:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run language-agnostic linters
+        uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace

docs/source/common.rst

@@ -20,27 +20,27 @@ Enums
        Arbitrary-angle measurement on the XY plane.
 
     .. py:attribute:: YZ
-        
+
        Arbitrary-angle measurement on the YZ plane.
 
     .. py:attribute:: XZ
-        
+
        Arbitrary-angle measurement on the XZ plane.
 
 .. class:: graphix_zx.common.Axis
-    
+
     Measurement axis for Pauli measurement.
 
     .. py:attribute:: X
 
         Pauli X-axis.
 
     .. py:attribute:: Y
-        
+
         Pauli Y-axis.
 
     .. py:attribute:: Z
-        
+
         Pauli Z-axis.
 
 .. class:: graphix_zx.common.Sign
@@ -52,7 +52,7 @@ Enums
       Positive sign.
 
     .. py:attribute:: MINUS
-        
+
       Negative sign.
 
 Abstract Base Classes

docs/source/conf.py

@@ -24,6 +24,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
     "sphinx.ext.autosectionlabel",
+    "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx_gallery.gen_gallery",
 ]
@@ -43,6 +44,11 @@
 html_title = " "
 # html_static_path = ["_static"]
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
+
 html_context = {
     "mode": "production",
 }

docs/source/euler.rst

@@ -0,0 +1,35 @@
+Euler
+=====
+
+:mod:`graphix_zx.euler` module
+++++++++++++++++++++++++++++++
+
+.. automodule:: graphix_zx.euler
+
+Local Operators
+---------------
+
+.. autoclass:: graphix_zx.euler.LocalUnitary
+    :members:
+    :show-inheritance:
+
+.. autoclass:: graphix_zx.euler.LocalClifford
+    :members:
+    :show-inheritance:
+
+Functions
+---------
+
+.. autofunction:: graphix_zx.euler.euler_decomposition
+
+.. autofunction:: graphix_zx.euler.bloch_sphere_coordinates
+
+.. autofunction:: graphix_zx.euler.is_close_angle
+
+.. autofunction:: graphix_zx.euler.is_clifford_angle
+
+.. autofunction:: graphix_zx.euler.meas_basis_info
+
+.. autofunction:: graphix_zx.euler.update_lc_lc
+
+.. autofunction:: graphix_zx.euler.update_lc_basis

docs/source/matrix.rst

@@ -0,0 +1,12 @@
+Matrix
+======
+
+:mod:`graphix_zx.matrix` module
++++++++++++++++++++++++++++++++
+
+.. automodule:: graphix_zx.matrix
+
+Functions
+---------
+
+.. autofunction:: graphix_zx.matrix.is_unitary

docs/source/references.rst

@@ -4,4 +4,6 @@ Module reference
 .. toctree::
     :maxdepth: 2
 
-    common
+    common
+    euler
+    matrix

examples/readme.rst

@@ -1,4 +1,4 @@
 Graphix-zx examples
 ====================
 
-Here are a few examples.
+Here are a few examples.

graphix_zx/common.py

@@ -100,18 +100,18 @@ def angle(self) -> float:
 
         Returns
         -------
-        float
+        `float`
             measurement angle
         """
         return self.__angle
 
     @typing_extensions.override
     def vector(self) -> NDArray[np.complex128]:
-        """Return the measurement basis vector.
+        r"""Return the measurement basis vector.
 
         Returns
         -------
-        NDArray[np.complex128]
+        `numpy.typing.NDArray`\[`numpy.complex128`\]
             measurement basis vector
         """
         return meas_basis(self.plane, self.angle)
@@ -193,7 +193,7 @@ def angle(self) -> float:
 
         Returns
         -------
-        float
+        `float`
             measurement angle
 
         Raises
@@ -212,11 +212,11 @@ def angle(self) -> float:
 
     @typing_extensions.override
     def vector(self) -> NDArray[np.complex128]:
-        """Return the measurement basis vector.
+        r"""Return the measurement basis vector.
 
         Returns
         -------
-        NDArray[np.complex128]
+        `numpy.typing.NDArray`\[`numpy.complex128`\]
             measurement basis vector
         """
         return meas_basis(self.plane, self.angle)
@@ -236,18 +236,18 @@ def default_meas_basis() -> PlannerMeasBasis:
 
 
 def meas_basis(plane: Plane, angle: float) -> NDArray[np.complex128]:
-    """Return the measurement basis vector corresponding to the plane and angle.
+    r"""Return the measurement basis vector corresponding to the plane and angle.
 
     Parameters
     ----------
     plane : `Plane`
         measurement plane
-    angle : float
+    angle : `float`
         measurement angle
 
     Returns
     -------
-    NDArray[np.complex128]
+    `numpy.typing.NDArray`\[`numpy.complex128`\]
         measurement basis vector
 
     Raises