deltakit-compile 0.1.0__tar.gz

deltakit_compile-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.3
+Name: deltakit-compile
+Version: 0.1.0
+Summary: A compiler toolkit for quantum error correction
+Author: Deltakit Team
+Author-email: Deltakit Team <deltakit@riverlane.com>
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Quantum Computing
+Classifier: Typing :: Typed
+Requires-Dist: xdsl>=0.66,<0.69
+Requires-Dist: typer>=0.15.4,<0.27
+Requires-Dist: pyyaml>=6.0.3,<7
+Requires-Dist: pydantic>=2.11.0a1,<3
+Requires-Dist: pydantic>=2.12,<3 ; python_full_version >= '3.14'
+Requires-Dist: pydantic-core>=2.28,<3
+Requires-Dist: numpy>=1.25,<3
+Requires-Dist: numpy>=1.26,<3 ; python_full_version >= '3.12'
+Requires-Dist: numpy>=2.1,<3 ; python_full_version >= '3.13'
+Requires-Dist: numpy>=2.3.4,<3 ; python_full_version >= '3.14'
+Requires-Dist: deltakit-stim>=0.2.2,<0.3
+Requires-Dist: typing-extensions>=4.15,<5
+Requires-Python: >=3.10, <3.15
+Project-URL: Homepage, https://github.com/Deltakit/deltakit-compile
+Project-URL: Source, https://github.com/Deltakit/deltakit-compile
+Project-URL: Documentation, https://deltakit.riverlane.com/
+Project-URL: Issues, https://github.com/Deltakit/deltakit-compile/issues
+Project-URL: Changelog, https://github.com/Deltakit/deltakit-compile/releases
+Description-Content-Type: text/markdown
+
+# Deltakit-compile
+
+`deltakit-compile` is a compiler implementation for Quantum Error Correction.
+
+## Installation 
+
+### With `pip`
+
+```
+python -m pip install deltakit-compile
+```
+
+### With `uv` 
+
+```
+uv pip install deltakit-compile
+```
+
+## Basic usage
+
+See the [public documentation](https://deltakit-docs.riverlane.com/en/latest/deltakit_compile/index.html)

deltakit_compile-0.1.0/README.md

@@ -0,0 +1,21 @@
+# Deltakit-compile
+
+`deltakit-compile` is a compiler implementation for Quantum Error Correction.
+
+## Installation 
+
+### With `pip`
+
+```
+python -m pip install deltakit-compile
+```
+
+### With `uv` 
+
+```
+uv pip install deltakit-compile
+```
+
+## Basic usage
+
+See the [public documentation](https://deltakit-docs.riverlane.com/en/latest/deltakit_compile/index.html)

deltakit_compile-0.1.0/pyproject.toml

@@ -0,0 +1,187 @@
+[project]
+name = "deltakit-compile"
+version = "0.1.0"
+description = "A compiler toolkit for quantum error correction"
+readme = "README.md"
+requires-python = ">=3.10,<3.15"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Quantum Computing",
+    "Typing :: Typed",
+]
+dependencies = [
+    "xdsl>=0.66,<0.69",
+    "typer>=0.15.4,<0.27",
+    "pyyaml >=6.0.3, <7",
+    "pydantic >=2.11.0a1, <3",
+    "pydantic >=2.12, <3; python_version >= '3.14'",
+    "pydantic-core >=2.28, <3",
+    "numpy >=1.25, <3",
+    "numpy >=1.26, <3; python_version >= '3.12'",
+    "numpy >=2.1, <3; python_version >= '3.13'",
+    "numpy >=2.3.4, <3; python_version >= '3.14'",
+    "deltakit-stim >=0.2.2, <0.3",
+    "typing_extensions >=4.15, <5",
+]
+
+[[project.authors]]
+name = "Deltakit Team"
+email = "deltakit@riverlane.com"
+
+[project.scripts]
+deltakit_compile = "deltakit_compile.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/Deltakit/deltakit-compile"
+Source = "https://github.com/Deltakit/deltakit-compile"
+Documentation = "https://deltakit.riverlane.com/"
+Issues = "https://github.com/Deltakit/deltakit-compile/issues"
+Changelog = "https://github.com/Deltakit/deltakit-compile/releases"
+
+[dependency-groups]
+examples = [
+    "ipykernel>=6.29.5,<8",
+    "stim >=1.14, <2",
+    "stim >=1.15, <2; python_version >= '3.13'",
+    "stim >=1.16, <2; python_version >= '3.14'",
+]
+test = [
+    "pytest >=8.4.0, <10",
+    "pytest-cov >=4.0.0, <8",
+    "pytest-mock >=3.14.0, <4",
+    "pytest-xdist >=3.8.0, <4",
+    "pytest-json-report >=1.5.0, <2",
+    "filecheck >=1.0.3, <2",
+    "filecheckize >=0.2, <0.3",
+    "lit >=18.1.8, <19",
+    "nbclient>=0.10.2,<0.12",
+    "coverage >=7.7.0, <8",
+    "packaging >=25.0, <27",
+    { include-group = "examples" },
+]
+typing = ["types-PyYAML >=5.4.2, <6"]
+lint = [
+    { include-group = "typing" },
+    "mypy>=2.2.0,<3",
+    "types-networkx >=3.1, <4",
+    "ruff==0.15.19",
+    "typos >=1.34, <2",
+    "deptry>=0.23,<0.26",
+    "pydoclint >=0.8.6, <0.9",
+]
+licences = ["pip-licenses >=3.5.3, <6"]
+security = [
+    "bandit[toml] >=1.7.5, <2",
+    "pip-audit>=2.8.0, <3",
+    "ochrona >=2.0.2, <3",
+]
+release = [
+    "python-semantic-release >=10.6.1, <11",
+    "packaging >=25.0, <27",
+    "requests>=2.32.0",
+    "tomlkit<0.16,>=0.13",
+]
+dev = [
+    { include-group = "test" },
+    { include-group = "lint" },
+    { include-group = "security" },
+    "pre-commit >=4.2, <5",
+    "validate-pyproject >=0.24.1, <0.26.0",
+]
+
+[tool.uv.build-backend]
+module-name = "deltakit_compile"
+module-root = "src"
+
+[tool.mypy]
+files = [
+    "src/**/*.py",
+    "tests/unit/**/*.py",
+]
+enable_error_code = ["deprecated"]
+
+[[tool.mypy.overrides]]
+module = ["stim"]
+follow_untyped_imports = true
+
+[[tool.mypy.overrides]]
+module = ["deltakit-stim"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["deltakit_compile.*"]
+disable_error_code = ["type-abstract"]
+enable_error_code = ["explicit-override"]
+
+[tool.typos.default]
+extend-ignore-re = ['"id"\s*:\s*"[0-9a-f]{8,}"']
+
+[tool.typos.default.extend-words]
+iy = "iy"
+iz = "iz"
+IZ = "IZ"
+anc = "anc"
+writeable = "writeable"
+CPY = "CPY"
+ser = "ser"
+
+[tool.deptry]
+known_first_party = ["deltakit_compile"]
+extend_exclude = ["examples"]
+
+[tool.deptry.per_rule_ignores]
+DEP001 = ["deltakit-stim"]
+
+[tool.bandit]
+exclude_dirs = [
+    ".github",
+    ".venv",
+    "**/lit.cfg.py",
+]
+skips = ["B101"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/unit"]
+filterwarnings = [
+    "ignore:cannot collect test class 'TestOp' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+    "ignore:cannot collect test class 'TestTermOp' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+    "ignore:cannot collect test class 'TestType' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+]
+
+[tool.coverage.report]
+exclude_also = [
+    "raise NotImplementedError",
+    "return NotImplemented",
+]
+
+[tool.coverage.paths]
+source = [
+    "src/deltakit_compile",
+    ".venv/lib/python*/site-packages/deltakit_compile",
+]
+
+[tool.pydoclint]
+style = "google"
+exclude = '\.git|\.venv.*'
+arg-type-hints-in-docstring = false
+check-return-types = false
+check-yield-types = false
+check-style-mismatch = true
+require-yield-section-when-yielding-nothing = false
+require-return-section-when-returning-nothing = false
+skip-checking-raises = true
+
+[build-system]
+requires = ["uv_build>=0.9.15"]
+build-backend = "uv_build"

deltakit_compile-0.1.0/pyproject.toml.orig

@@ -0,0 +1,187 @@
+[project]
+name = "deltakit-compile"
+version = "0.1.0"
+description = "A compiler toolkit for quantum error correction"
+readme = "README.md"
+authors = [{ name = "Deltakit Team", email = "deltakit@riverlane.com" }]
+requires-python = ">=3.10,<3.15"
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering :: Quantum Computing",
+  "Typing :: Typed",
+]
+
+dependencies = [
+  "xdsl>=0.66,<0.69",
+  "typer>=0.15.4,<0.27",
+  "pyyaml >=6.0.3, <7",
+  "pydantic >=2.11.0a1, <3",
+  "pydantic >=2.12, <3; python_version >= '3.14'",
+  "pydantic-core >=2.28, <3",
+  "numpy >=1.25, <3",
+  "numpy >=1.26, <3; python_version >= '3.12'",
+  "numpy >=2.1, <3; python_version >= '3.13'",
+  "numpy >=2.3.4, <3; python_version >= '3.14'",
+  "deltakit-stim >=0.2.2, <0.3",
+  "typing_extensions >=4.15, <5",
+]
+
+[dependency-groups]
+examples = [
+  "ipykernel>=6.29.5,<8",
+  "stim >=1.14, <2",
+  "stim >=1.15, <2; python_version >= '3.13'",
+  "stim >=1.16, <2; python_version >= '3.14'",
+]
+test = [
+  "pytest >=8.4.0, <10",
+  "pytest-cov >=4.0.0, <8",
+  "pytest-mock >=3.14.0, <4",
+  "pytest-xdist >=3.8.0, <4",
+  "pytest-json-report >=1.5.0, <2",
+  "filecheck >=1.0.3, <2",
+  "filecheckize >=0.2, <0.3",
+  "lit >=18.1.8, <19",
+  "nbclient>=0.10.2,<0.12",
+  "coverage >=7.7.0, <8",
+  "packaging >=25.0, <27",
+  { include-group = "examples" },
+]
+typing = ["types-PyYAML >=5.4.2, <6"]
+lint = [
+  { include-group = "typing" },
+  "mypy>=2.2.0,<3",
+  "types-networkx >=3.1, <4",
+  "ruff==0.15.19",
+  "typos >=1.34, <2",
+  "deptry>=0.23,<0.26",
+  "pydoclint >=0.8.6, <0.9",
+]
+licences = ["pip-licenses >=3.5.3, <6"]
+security = [
+  "bandit[toml] >=1.7.5, <2",
+  "pip-audit>=2.8.0, <3",
+  "ochrona >=2.0.2, <3",
+]
+release = [
+  "python-semantic-release >=10.6.1, <11",
+  "packaging >=25.0, <27",
+  "requests>=2.32.0",
+  "tomlkit<0.16,>=0.13",
+]
+dev = [
+  { include-group = "test" },
+  { include-group = "lint" },
+  { include-group = "security" },
+  "pre-commit >=4.2, <5",
+  "validate-pyproject >=0.24.1, <0.26.0",
+]
+
+[project.scripts]
+deltakit_compile = "deltakit_compile.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/Deltakit/deltakit-compile"
+Source = "https://github.com/Deltakit/deltakit-compile"
+Documentation = "https://deltakit.riverlane.com/"
+Issues = "https://github.com/Deltakit/deltakit-compile/issues"
+Changelog = "https://github.com/Deltakit/deltakit-compile/releases"
+
+[tool.uv.build-backend]
+module-name = "deltakit_compile"
+module-root = "src"
+
+[build-system]
+requires = ["uv_build>=0.9.15"]
+build-backend = "uv_build"
+
+[tool.mypy]
+files = ["src/**/*.py", "tests/unit/**/*.py"]
+enable_error_code = ["deprecated"]
+
+[[tool.mypy.overrides]]
+module = ["stim"]
+follow_untyped_imports = true
+
+[[tool.mypy.overrides]]
+module = ["deltakit-stim"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["deltakit_compile.*"]
+disable_error_code = ["type-abstract"]
+enable_error_code = ["explicit-override"]
+
+[tool.typos.default]
+extend-ignore-re = [
+  # Ignore jupyter notebook cell IDs
+  "\"id\"\\s*:\\s*\"[0-9a-f]{8,}\"",
+]
+
+[tool.typos.default.extend-words]
+# Don't correct "iy" - often used in the context of "probability of an IY operation"
+iy = "iy"
+iz = "iz"
+IZ = "IZ"
+anc = "anc"
+writeable = "writeable" # Used in numpy APIs.
+CPY = "CPY"             # A ruff rule identifier
+ser = "ser"             # Used by a pydantic function.
+
+[tool.deptry]
+known_first_party = ["deltakit_compile"]
+extend_exclude = ["examples"]
+
+[tool.deptry.per_rule_ignores]
+DEP001 = ['deltakit-stim']
+
+[tool.bandit]
+exclude_dirs = ['.github', '.venv', '**/lit.cfg.py']
+skips = [
+  'B101', # We are happy to use asserts as part of defensive programming
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/unit"]
+filterwarnings = [
+  "ignore:cannot collect test class 'TestOp' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+  "ignore:cannot collect test class 'TestTermOp' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+  "ignore:cannot collect test class 'TestType' because it has a __init__ constructor:pytest.PytestCollectionWarning",
+]
+
+[tool.coverage.report]
+exclude_also = ["raise NotImplementedError", "return NotImplemented"]
+
+[tool.coverage.paths]
+source = [
+  "src/deltakit_compile",
+  ".venv/lib/python*/site-packages/deltakit_compile",
+]
+
+[tool.pydoclint]
+style = 'google'
+exclude = '\.git|\.venv.*'
+# We do not want type hints to be duplicated in docstrings.
+arg-type-hints-in-docstring = false
+check-return-types = false
+check-yield-types = false
+# Ensure that Google style is used
+check-style-mismatch = true
+# Empty yields or returns do not have to be documented.
+require-yield-section-when-yielding-nothing = false
+require-return-section-when-returning-nothing = false
+# The raise checks are oddly restrictive - forcing us to document exceptions in the function
+# body and nothing more.
+skip-checking-raises = true

deltakit_compile-0.1.0/src/deltakit_compile/__init__.py

@@ -0,0 +1,2 @@
+# (c) Copyright Riverlane 2025-2026. All rights reserved.
+"""deltakit-compile is the compiler infrastructure of Deltakit."""

deltakit_compile-0.1.0/src/deltakit_compile/cli.py

@@ -0,0 +1,201 @@
+# (c) Copyright Riverlane 2025-2026. All rights reserved.
+"""
+CLI module
+"""
+
+import importlib.metadata
+import json
+from pathlib import Path
+from typing import Annotated
+
+import typer
+from deltakit_stim import Circuit
+from typer.core import TyperGroup
+from typing_extensions import override
+from xdsl.parser import Parser
+
+from deltakit_compile.constants import DIST_NAME
+from deltakit_compile.frontend.deltakit_stim.io import (
+    deltakit_stim_circuit_to_dialect,
+    deltakit_stim_context,
+    deltakit_stim_dialect_to_circuit,
+)
+from deltakit_compile.pass_runner import ArgumentDict, PassRunner
+
+
+class OrderCommands(TyperGroup):
+    """Subclass enforcing that commands are ordered in alphabetical order in the help messages."""
+
+    @override
+    def list_commands(self, ctx):
+        return sorted(self.commands)
+
+
+app = typer.Typer(
+    cls=OrderCommands,
+    add_completion=False,
+    no_args_is_help=True,
+    pretty_exceptions_show_locals=False,
+)
+
+
+# region Deltakit-Stim commands
+
+deltakit_stim_app = typer.Typer(
+    cls=OrderCommands,
+    add_completion=False,
+    no_args_is_help=True,
+    pretty_exceptions_show_locals=False,
+)
+app.add_typer(
+    deltakit_stim_app,
+    name="deltakit-stim",
+    help="Commands for converting between MLIR and Deltakit-Stim circuits.",
+)
+
+
+@deltakit_stim_app.command("parse")
+def parse_deltakit_stim(
+    input_path: Annotated[
+        Path,
+        typer.Argument(
+            exists=True, dir_okay=False, help="Path to the input Deltakit-Stim circuit."
+        ),
+    ],
+    output_path: Annotated[
+        Path | None,
+        typer.Option(
+            "--output",
+            "-O",
+            help="Destination path for the output MLIR file. "
+            "If not specified, it's next to the input file with an _out suffix.",
+        ),
+    ] = None,
+) -> None:
+    """Convert a Deltakit-Stim circuit to an MLIR file containing operations from Deltakit's stim
+    and deltakit-stim dialects."""
+    circuit = Circuit.from_file(input_path)
+    module_op = deltakit_stim_circuit_to_dialect(circuit)
+
+    # If no output path provided, use input filename with _out
+    if output_path is None:
+        output_path = input_path.with_name(f"{input_path.stem}_out.mlir")
+
+    output_path.write_text(str(module_op), encoding="utf-8")
+    print(f"Output program file saved at: {output_path}")  # noqa: T201
+
+
+@deltakit_stim_app.command("print")
+def print_deltakit_stim(
+    input_path: Annotated[
+        Path, typer.Argument(exists=True, dir_okay=False, help="Path to the input MLIR file.")
+    ],
+    output_path: Annotated[
+        Path | None,
+        typer.Option(
+            "--output",
+            "-O",
+            help="Destination path for the output Deltakit-Stim circuit. "
+            "If not specified, it's next to the input file with an _out suffix.",
+        ),
+    ] = None,
+) -> None:
+    """Convert an MLIR file containing operations from Deltakit's stim and deltakit-stim dialects
+    into a Deltakit-Stim circuit."""
+    module_str = input_path.read_text(encoding="utf-8")
+    module_op = Parser(deltakit_stim_context(), module_str).parse_module()
+    circuit = deltakit_stim_dialect_to_circuit(module_op)
+
+    # If no output path provided, use input filename with _out
+    if output_path is None:
+        output_path = input_path.with_name(f"{input_path.stem}_out.stim")
+
+    circuit.to_file(output_path)
+    print(f"Output program file saved at: {output_path}")  # noqa: T201
+
+
+# endregion
+
+# region root commands
+
+
+def _parse_pass_arguments(params_str: str) -> ArgumentDict:
+    """Parse a JSON string of pass arguments into a dictionary."""
+    try:
+        input_parameters = json.loads(params_str)
+        if not isinstance(input_parameters, dict):
+            msg = f"Pass arguments are {type(input_parameters)}, but should be a dictionary"
+            raise ValueError(msg)
+
+        return input_parameters
+    except ValueError as exp:
+        msg = "Pass arguments must be in a valid JSON dictionary"
+        raise ValueError(msg) from exp
+
+
+@app.command("compile-passes")
+def compile_passes(
+    input_path: Annotated[
+        Path,
+        typer.Argument(exists=True, dir_okay=False, help="Path to the input program file."),
+    ],
+    output_path: Annotated[
+        Path | None,
+        typer.Option(
+            "--output",
+            "-O",
+            help="Destination path for the compiled file. "
+            "If not specified, it defaults to the input file's directory with an _out suffix.",
+        ),
+    ] = None,
+    passes: Annotated[
+        list[str] | None,
+        typer.Option(
+            "--pass",
+            "-p",
+            help="Compiler pass to be run on the input file. "
+            "Use this multiple times for multiple passes, run in the order listed.",
+        ),
+    ] = None,
+    pass_args: str = typer.Option(
+        default="{}",
+        help="Additional arguments to be provided to the compiler passes. "
+        "These must be in the form of a JSON dict, e.g. '{\"param\": 0xFF}'.",
+    ),
+    test_mode: Annotated[
+        bool,
+        typer.Option(
+            "--test-mode",
+            "-t",
+            help="Flag to enable a testing mode where the Test dialect can be used.",
+        ),
+    ] = False,
+) -> None:
+    """Run individual compiler passes on an MLIR file.
+
+    With this you can run any passes in any order with any arguments with no guard rails (for
+    testing and experimentation). Multiple module ops can be in the same input MLIR file (treated as
+    separate programs) if separated by '// ----' lines."""
+    program = input_path.read_text(encoding="utf-8")
+    params = _parse_pass_arguments(pass_args)
+    output_program = PassRunner(include_test_dialect=test_mode).run(
+        program, passes if passes is not None else [], params
+    )
+
+    if output_path is None:
+        output_path = input_path.with_name(f"{input_path.stem}_out.mlir")
+
+    output_path.write_text(output_program, encoding="utf-8")
+    print(f"Output program file saved at: {output_path}")  # noqa: T201
+
+
+@app.command("version")
+def deltakit_compile_version() -> None:
+    """Print the version of deltakit_compile."""
+    print(f"deltakit_compile v{importlib.metadata.version(DIST_NAME)}")  # noqa: T201
+
+
+# endregion
+
+if __name__ == "__main__":  # pragma: no cover
+    app()

deltakit_compile-0.1.0/src/deltakit_compile/constants.py

@@ -0,0 +1,6 @@
+# (c) Copyright Riverlane 2025-2026. All rights reserved.
+"""Constants for deltakit_compile package."""
+
+from typing import Final
+
+DIST_NAME: Final[str] = "deltakit_compile"