Setup repository

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Report a bug
+title: "[Bug]: "
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment (please complete the following information):**
+
+- OS: [e.g. Windows11, macOS Sequoia]
+- Python version: [e.g. 3.12.1]
+- Related module versions if applicable: [e.g. numpy=2.2.0]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: new feature
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the feature you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    ignore:
+      - dependency-name: "numpy"
+        update-types: ["version-update:semver-major"]
+  - package-ecosystem: "github-actions"
+    directory: "/.github/workflows"
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+Before submitting, please check the following:
+
+- Make sure you have tests for the new code and that test passes (run `pytest`)
+- If applicable, add a line to the [unreleased] part of CHANGELOG.md, following [keep-a-changelog](https://keepachangelog.com/en/1.0.0/).
+- Format added code by `ruff`
+- Type checking by `mypy` and `pyright`
+- Make sure the checks (github actions) pass.
+- Check that the docs compile without errors (run `make html` in `./docs/` - you may need to install dependency for sphinx docs, see `docs/requirements.txt`.)
+
+Then, please fill in below:
+
+**Context (if applicable):**
+
+**Description of the change:**
+
+**Related issue:**

.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,24 @@
+name: Auto-merge Dependabot PRs
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  auto-merge:
+    if: github.actor == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Approve PR
+        run: gh pr review --approve "$PR_URL"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Enable auto-merge
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/doc.yml

@@ -0,0 +1,31 @@
+name: doc
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  check-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: pip install --upgrade pip
+
+      - run: pip install -v -e .[dev]
+
+      - name: Make docs
+        run: sphinx-build -W docs/source docs/build
+
+      - name: Save docs
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: docs/build

.github/workflows/pytest.yml

@@ -0,0 +1,34 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: pytest
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  standard:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "windows-2022", "macos-latest"]
+        python: ["3.9", "3.10", "3.11", "3.12"]
+
+    name: "Python ${{ matrix.python }} / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+          pytest

.github/workflows/ruff.yml

@@ -0,0 +1,31 @@
+name: ruff
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  ruff_check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: chartboost/ruff-action@v1
+
+  ruff_format:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: "format --check"
+
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: "check --select I"

.github/workflows/typecheck.yml

@@ -0,0 +1,27 @@
+name: Type Checking
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  typecheck:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        tool: [mypy, pyright]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - run: |
+          python3 -m pip install -U pip
+          pip install .[dev]
+          ${{ matrix.tool }}

.gitignore

@@ -160,3 +160,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Custom stuff
+docs/source/gallery

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/__init__.py

@@ -0,0 +1 @@
+"""Sphinx documentation package for graphix-zx."""

docs/source/common.rst

@@ -0,0 +1,84 @@
+Common
+========
+
+:mod:`graphix_zx.common` module
+++++++++++++++++++++++++++++++++
+
+.. automodule:: graphix_zx.common
+
+Enums
+-----
+
+.. class:: graphix_zx.common.Plane
+
+    Measurement planes for MBQC.
+
+    We distinguish the axial measurements from the planar measurements.
+
+    .. py:attribute:: XY
+
+       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
+
+    Measurement sign for Pauli measurement.
+
+    .. py:attribute:: PLUS
+
+      Positive sign.
+
+    .. py:attribute:: MINUS
+
+      Negative sign.
+
+Abstract Base Classes
+---------------------
+
+.. autoclass:: graphix_zx.common.MeasBasis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Measurement Basis Classes
+-------------------------
+
+.. autoclass:: graphix_zx.common.PlannerMeasBasis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: graphix_zx.common.AxisMeasBasis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Functions
+---------
+
+.. autofunction:: graphix_zx.common.default_meas_basis
+
+.. autofunction:: graphix_zx.common.meas_basis