graphqomb 0.2.0__tar.gz

graphqomb-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Masato Fukushima and Contributors
+
+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.

graphqomb-0.2.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: graphqomb
+Version: 0.2.0
+Summary: A modular Graph State qompiler for measurement-based quantum computing.
+Author: Sora Shiratani, Yuki Watanabe, Daichi Sasaki
+Author-email: Masato Fukushima <masa1063fuk@gmail.com>
+Maintainer-email: Masato Fukushima <masa1063fuk@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/TeamGraphix/graphqomb
+Project-URL: Documentation, https://graphqomb.readthedocs.io/
+Project-URL: Repository, https://github.com/TeamGraphix/graphqomb
+Project-URL: Changelog, https://github.com/TeamGraphix/graphqomb/blob/master/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/TeamGraphix/graphqomb/issues
+Keywords: quantum computing,MBQC,measurement-based quantum computing,quantum compilation,fault-tolerant quantum computing,graph state
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Quantum Computing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.14,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3,>=1.22
+Requires-Dist: matplotlib
+Requires-Dist: networkx
+Requires-Dist: ortools<10,>=9
+Requires-Dist: typing_extensions
+Provides-Extra: dev
+Requires-Dist: ruff==0.14.10; extra == "dev"
+Requires-Dist: mypy==1.19.1; extra == "dev"
+Requires-Dist: pyright==1.1.407; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: types-networkx; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: sphinx>=7.4.0; extra == "doc"
+Requires-Dist: sphinx_gallery>=0.17.0; extra == "doc"
+Requires-Dist: furo>=2024.01.29; extra == "doc"
+Requires-Dist: matplotlib>=3.7.0; extra == "doc"
+Dynamic: license-file
+
+# GraphQOMB
+
+![License](https://img.shields.io/github/license/TeamGraphix/graphqomb)
+[![PyPI version](https://badge.fury.io/py/graphqomb.svg)](https://badge.fury.io/py/graphqomb)
+[![Python Versions](https://img.shields.io/pypi/pyversions/graphqomb.svg)](https://pypi.org/project/graphqomb/)
+[![Documentation Status](https://readthedocs.org/projects/graphqomb/badge/?version=latest)](https://graphqomb.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/TeamGraphix/graphqomb/branch/master/graph/badge.svg)](https://codecov.io/gh/TeamGraphix/graphqomb)
+[![pytest](https://github.com/TeamGraphix/graphqomb/actions/workflows/pytest.yml/badge.svg)](https://github.com/TeamGraphix/graphqomb/actions/workflows/pytest.yml)
+[![typecheck](https://github.com/TeamGraphix/graphqomb/actions/workflows/typecheck.yml/badge.svg)](https://github.com/TeamGraphix/graphqomb/actions/workflows/typecheck.yml)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**GraphQOMB** (Qompiler for Measurement-Based Quantum Computing, pronounce as _graphcomb_) is a modular graph-based compiler for measurement-based quantum computing (MBQC), providing a high-level interface to the [graphix](https://github.com/TeamGraphix/graphix) package for applications such as fault-tolerant MBQC.
+
+GraphQOMB's philosophy is to use graph-like ZX diagrams as MBQC representation, with feedforward strategy treated independently.
+This allows, for example, to integrate Pauli frame tracking needed for fault-tolerant MBQC, into basic feedforward strategy of MBQC, allowing streamlined compilation.
+
+## Features
+
+### Computation Design
+
+- **ZX-Calculus Integration**: Use ZX-diagrams as an abstract expression of measurement pattern
+- **Feedforward Strategy Design**: Our library accepts general feedforward strategy and optimization, eliminating the necessity of measurement calculus
+- **Scheduler**: Scheduling the node preparation and measurement time
+
+### Compilation
+
+- **MBQC Pattern Generation**: Measurement pattern is treated as a quantum assembly
+- **Pauli Frame Tracking**: Manage all the classical feedforward with Pauli Frame, enabling fault-tolerant computing as well
+
+### Simulation
+
+- **Pattern Simulation**: Simulate measurement patterns with statevector backend
+- **Simulation in Stim circuit**: Generate a stim circuit implementing a fault-tolerant MBQC
+
+### Others
+
+- **Transpilation into Graphix Pattern**: Transpile generated pattern into `graphix.pattern.Pattern` object for variety of execution backend (WIP)
+- **Visualization**: Visualize graph states
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install graphqomb
+```
+
+### From Source (Development)
+
+```bash
+git clone https://github.com/TeamGraphix/graphqomb.git
+cd graphqomb/
+pip install -e .
+```
+
+Install with development dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+Install with documentation dependencies:
+
+```bash
+pip install -e .[doc]
+```
+
+## Quick Start
+
+### Prepare Resource State and Feedforward
+
+```python
+from graphqomb.circuit import Circuit, circuit2graph
+from graphqomb.gates import H, CNOT
+from graphqomb.qompiler import qompile
+from graphqomb.simulator import PatternSimulator, SimulatorBackend
+
+# Create a quantum circuit
+circuit = Circuit(2)
+circuit.apply_macro_gate(H(0))
+circuit.apply_macro_gate(CNOT((0, 1)))
+
+graph, feedforward = circuit2graph(circuit)
+
+# Compile into pattern
+pattern = qompile(graph, feedforward)
+
+# Simulate the pattern
+simulator = PatternSimulator(pattern, SimulatorBackend.StateVector)
+simulator.simulate()
+print(simulator.state)
+```
+
+### Creating and Visualizing Graph States
+
+```python
+from graphqomb.graphstate import GraphState
+from graphqomb.visualizer import visualize
+
+# Create a graph state using from_graph
+graph, node_map = GraphState.from_graph(
+    nodes=["input", "middle", "output"],
+    edges=[("input", "middle"), ("middle", "output")],
+    inputs=["input"],
+    outputs=["output"]
+)
+
+# Visualize the graph
+visualize(graph)
+```
+
+## Documentation
+
+- **Tutorial**: [WIP] for detailed usage guides
+- **Examples**: See [examples](https://graphqomb.readthedocs.io/en/latest/gallery/index.html) for code demonstrations
+- **API Reference**: Full API documentation is available [here](https://graphqomb.readthedocs.io/en/latest/references.html)
+
+## Development
+
+### Running Tests
+
+```bash
+pytest                              # Run all tests
+pytest tests/test_specific.py       # Run specific test file
+```
+
+### Code Quality
+
+```bash
+ruff check                          # Lint code
+ruff format                         # Format code
+mypy                                # Type checking
+pyright                             # Type checking
+```
+
+### Building Documentation
+
+```bash
+cd docs/
+make html                           # Build HTML documentation
+# Output will be in docs/build/html/
+```
+
+## Project Structure
+
+```
+graphqomb/
+├── graphqomb/               # Main source code
+│   ├── circuit.py           # Quantum circuit implementation
+│   ├── graphstate.py        # Graph state manipulation
+|   ├── scheduler.py         # Scheduling computaional order
+│   ├── qompiler.py          # Generate MBQC pattern
+│   ├── simulator.py         # Pattern simulation
+│   ├── visualizer.py        # Visualization tools
+│   └── ...
+├── tests/                   # Test suite
+├── examples/                # Example scripts
+├── docs/                    # Sphinx documentation
+│   └── source/
+│       ├── gallery/         # Example gallery
+│       └── ...
+└── pyproject.toml          # Project configuration
+```
+
+## Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Ensure all tests pass and code is properly formatted
+5. Submit a pull request
+
+## Related Projects
+
+- [graphix](https://github.com/TeamGraphix/graphix): The original MBQC library
+- [PyZX](https://github.com/Quantomatic/pyzx): ZX-calculus library for Python
+- [swiflow](https://github.com/TeamGraphix/swiflow): Rust-based fast flow finding algorithms
+
+## License
+
+[MIT License](LICENSE)
+
+## Citation
+
+If you use GraphQOMB in your research, please cite:
+
+```bibtex
+@software{graphqomb,
+  title = {GraphQOMB: A Modular Graph State Qompiler for Measurement-Based Quantum Computation},
+  author = {Masato Fukushima, Sora Shiratani, Yuki Watanabe, and Daichi Sasaki},
+  year = {2025},
+  url = {https://github.com/TeamGraphix/graphqomb}
+}
+```
+
+## Acknowledgements
+
+We acknowledge the [NICT Quantum Camp](https://nqc.nict.go.jp/) for supporting our development.
+
+Special thanks to Fixstars Amplify:
+
+<p><a href="https://amplify.fixstars.com/en/">
+<img src="https://github.com/TeamGraphix/graphix/raw/master/docs/imgs/fam_logo.png" alt="amplify" width="200"/>
+</a></p>

graphqomb-0.2.0/README.md

@@ -0,0 +1,206 @@
+# GraphQOMB
+
+![License](https://img.shields.io/github/license/TeamGraphix/graphqomb)
+[![PyPI version](https://badge.fury.io/py/graphqomb.svg)](https://badge.fury.io/py/graphqomb)
+[![Python Versions](https://img.shields.io/pypi/pyversions/graphqomb.svg)](https://pypi.org/project/graphqomb/)
+[![Documentation Status](https://readthedocs.org/projects/graphqomb/badge/?version=latest)](https://graphqomb.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/TeamGraphix/graphqomb/branch/master/graph/badge.svg)](https://codecov.io/gh/TeamGraphix/graphqomb)
+[![pytest](https://github.com/TeamGraphix/graphqomb/actions/workflows/pytest.yml/badge.svg)](https://github.com/TeamGraphix/graphqomb/actions/workflows/pytest.yml)
+[![typecheck](https://github.com/TeamGraphix/graphqomb/actions/workflows/typecheck.yml/badge.svg)](https://github.com/TeamGraphix/graphqomb/actions/workflows/typecheck.yml)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**GraphQOMB** (Qompiler for Measurement-Based Quantum Computing, pronounce as _graphcomb_) is a modular graph-based compiler for measurement-based quantum computing (MBQC), providing a high-level interface to the [graphix](https://github.com/TeamGraphix/graphix) package for applications such as fault-tolerant MBQC.
+
+GraphQOMB's philosophy is to use graph-like ZX diagrams as MBQC representation, with feedforward strategy treated independently.
+This allows, for example, to integrate Pauli frame tracking needed for fault-tolerant MBQC, into basic feedforward strategy of MBQC, allowing streamlined compilation.
+
+## Features
+
+### Computation Design
+
+- **ZX-Calculus Integration**: Use ZX-diagrams as an abstract expression of measurement pattern
+- **Feedforward Strategy Design**: Our library accepts general feedforward strategy and optimization, eliminating the necessity of measurement calculus
+- **Scheduler**: Scheduling the node preparation and measurement time
+
+### Compilation
+
+- **MBQC Pattern Generation**: Measurement pattern is treated as a quantum assembly
+- **Pauli Frame Tracking**: Manage all the classical feedforward with Pauli Frame, enabling fault-tolerant computing as well
+
+### Simulation
+
+- **Pattern Simulation**: Simulate measurement patterns with statevector backend
+- **Simulation in Stim circuit**: Generate a stim circuit implementing a fault-tolerant MBQC
+
+### Others
+
+- **Transpilation into Graphix Pattern**: Transpile generated pattern into `graphix.pattern.Pattern` object for variety of execution backend (WIP)
+- **Visualization**: Visualize graph states
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install graphqomb
+```
+
+### From Source (Development)
+
+```bash
+git clone https://github.com/TeamGraphix/graphqomb.git
+cd graphqomb/
+pip install -e .
+```
+
+Install with development dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+Install with documentation dependencies:
+
+```bash
+pip install -e .[doc]
+```
+
+## Quick Start
+
+### Prepare Resource State and Feedforward
+
+```python
+from graphqomb.circuit import Circuit, circuit2graph
+from graphqomb.gates import H, CNOT
+from graphqomb.qompiler import qompile
+from graphqomb.simulator import PatternSimulator, SimulatorBackend
+
+# Create a quantum circuit
+circuit = Circuit(2)
+circuit.apply_macro_gate(H(0))
+circuit.apply_macro_gate(CNOT((0, 1)))
+
+graph, feedforward = circuit2graph(circuit)
+
+# Compile into pattern
+pattern = qompile(graph, feedforward)
+
+# Simulate the pattern
+simulator = PatternSimulator(pattern, SimulatorBackend.StateVector)
+simulator.simulate()
+print(simulator.state)
+```
+
+### Creating and Visualizing Graph States
+
+```python
+from graphqomb.graphstate import GraphState
+from graphqomb.visualizer import visualize
+
+# Create a graph state using from_graph
+graph, node_map = GraphState.from_graph(
+    nodes=["input", "middle", "output"],
+    edges=[("input", "middle"), ("middle", "output")],
+    inputs=["input"],
+    outputs=["output"]
+)
+
+# Visualize the graph
+visualize(graph)
+```
+
+## Documentation
+
+- **Tutorial**: [WIP] for detailed usage guides
+- **Examples**: See [examples](https://graphqomb.readthedocs.io/en/latest/gallery/index.html) for code demonstrations
+- **API Reference**: Full API documentation is available [here](https://graphqomb.readthedocs.io/en/latest/references.html)
+
+## Development
+
+### Running Tests
+
+```bash
+pytest                              # Run all tests
+pytest tests/test_specific.py       # Run specific test file
+```
+
+### Code Quality
+
+```bash
+ruff check                          # Lint code
+ruff format                         # Format code
+mypy                                # Type checking
+pyright                             # Type checking
+```
+
+### Building Documentation
+
+```bash
+cd docs/
+make html                           # Build HTML documentation
+# Output will be in docs/build/html/
+```
+
+## Project Structure
+
+```
+graphqomb/
+├── graphqomb/               # Main source code
+│   ├── circuit.py           # Quantum circuit implementation
+│   ├── graphstate.py        # Graph state manipulation
+|   ├── scheduler.py         # Scheduling computaional order
+│   ├── qompiler.py          # Generate MBQC pattern
+│   ├── simulator.py         # Pattern simulation
+│   ├── visualizer.py        # Visualization tools
+│   └── ...
+├── tests/                   # Test suite
+├── examples/                # Example scripts
+├── docs/                    # Sphinx documentation
+│   └── source/
+│       ├── gallery/         # Example gallery
+│       └── ...
+└── pyproject.toml          # Project configuration
+```
+
+## Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Ensure all tests pass and code is properly formatted
+5. Submit a pull request
+
+## Related Projects
+
+- [graphix](https://github.com/TeamGraphix/graphix): The original MBQC library
+- [PyZX](https://github.com/Quantomatic/pyzx): ZX-calculus library for Python
+- [swiflow](https://github.com/TeamGraphix/swiflow): Rust-based fast flow finding algorithms
+
+## License
+
+[MIT License](LICENSE)
+
+## Citation
+
+If you use GraphQOMB in your research, please cite:
+
+```bibtex
+@software{graphqomb,
+  title = {GraphQOMB: A Modular Graph State Qompiler for Measurement-Based Quantum Computation},
+  author = {Masato Fukushima, Sora Shiratani, Yuki Watanabe, and Daichi Sasaki},
+  year = {2025},
+  url = {https://github.com/TeamGraphix/graphqomb}
+}
+```
+
+## Acknowledgements
+
+We acknowledge the [NICT Quantum Camp](https://nqc.nict.go.jp/) for supporting our development.
+
+Special thanks to Fixstars Amplify:
+
+<p><a href="https://amplify.fixstars.com/en/">
+<img src="https://github.com/TeamGraphix/graphix/raw/master/docs/imgs/fam_logo.png" alt="amplify" width="200"/>
+</a></p>

graphqomb-0.2.0/docs/requirements.txt

@@ -0,0 +1,5 @@
+sphinx>=7.4.0
+sphinx_gallery>=0.17.0
+furo>=2024.01.29
+
+matplotlib>=3.7.0

graphqomb-0.2.0/graphqomb/__init__.py

@@ -0,0 +1 @@
+"""GraphQOMB library."""