metalq 0.1.0__tar.gz

metalq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Masaki Shiraishi
+
+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.

metalq-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include Makefile
+
+# Native libraries
+recursive-include metalq/python/metalq/lib *.dylib *.metallib
+
+# Source files for building
+recursive-include native *.m *.h *.metal

metalq-0.1.0/Makefile

@@ -0,0 +1,65 @@
+# Metal-Q Makefile
+
+CC = clang
+OBJC = clang
+METAL = xcrun -sdk macosx metal
+METALLIB = xcrun -sdk macosx metallib
+
+CFLAGS = -Wall -O2 -fPIC
+OBJCFLAGS = -Wall -O2 -fPIC -fobjc-arc -framework Foundation -framework Metal
+
+SRC_DIR = native
+BUILD_DIR = build
+PYTHON_DIR = metalq/python/metalq
+
+# Source files
+OBJC_SRCS = $(SRC_DIR)/metalq.m \
+            $(SRC_DIR)/state_vector.m \
+            $(SRC_DIR)/gate_executor.m \
+            $(SRC_DIR)/measurement.m
+
+METAL_SRC = $(SRC_DIR)/shaders/quantum_gates.metal
+MEASUREMENT_METAL_SRC = $(SRC_DIR)/shaders/measurement.metal
+
+# Output
+DYLIB = $(BUILD_DIR)/libmetalq.dylib
+METALLIB_OUT = $(BUILD_DIR)/quantum_gates.metallib
+
+.PHONY: all clean install test dirs
+
+all: dirs $(DYLIB) $(METALLIB_OUT)
+
+dirs:
+	mkdir -p $(BUILD_DIR)
+
+# Compile Metal shaders (both quantum_gates and measurement)
+$(BUILD_DIR)/quantum_gates.air: $(METAL_SRC)
+	$(METAL) -c $< -o $@
+
+$(BUILD_DIR)/measurement.air: $(MEASUREMENT_METAL_SRC)
+	$(METAL) -c $< -o $@
+
+$(METALLIB_OUT): $(BUILD_DIR)/quantum_gates.air $(BUILD_DIR)/measurement.air
+	$(METALLIB) $(BUILD_DIR)/quantum_gates.air $(BUILD_DIR)/measurement.air -o $@
+
+# Build dynamic library
+$(DYLIB): $(OBJC_SRCS)
+	$(OBJC) $(OBJCFLAGS) \
+		-dynamiclib \
+		-install_name @rpath/libmetalq.dylib \
+		$(OBJC_SRCS) \
+		-o $@
+
+# Install to Python package
+install: all
+	mkdir -p $(PYTHON_DIR)/lib
+	cp $(DYLIB) $(PYTHON_DIR)/lib/
+	cp $(METALLIB_OUT) $(PYTHON_DIR)/lib/
+
+# Run tests
+test: install
+	cd metalq/python && uv run pytest ../../tests/ -v
+
+clean:
+	rm -rf $(BUILD_DIR)
+	rm -rf $(PYTHON_DIR)/lib

metalq-0.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: metalq
+Version: 0.1.0
+Summary: High-performance quantum circuit simulator for Apple Silicon using Metal GPU
+Author: Metal-Q Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/masa-whitestone/metal-quantum
+Project-URL: Repository, https://github.com/masa-whitestone/metal-quantum.git
+Project-URL: Issues, https://github.com/masa-whitestone/metal-quantum/issues
+Keywords: quantum,quantum-computing,simulator,qiskit,apple-silicon,metal,gpu
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: qiskit<3.0.0,>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: qiskit-aer>=0.13.0; extra == "dev"
+Dynamic: license-file
+
+# Metal-Q ⚛️🍎
+
+A high-performance quantum circuit simulator for Apple Silicon, using Metal GPU acceleration.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Qiskit 2.x](https://img.shields.io/badge/Qiskit-2.x-6929C4.svg)](https://qiskit.org/)
+
+## Overview
+
+Metal-Q is a drop-in replacement for Qiskit's statevector simulator, optimized for Apple Silicon GPUs. It leverages Metal compute shaders to achieve significant speedups on M1/M2/M3/M4 Macs.
+
+### Key Features
+
+- 🚀 **Up to 32x faster** than Qiskit for large circuits
+- 🔌 **Drop-in compatible** with Qiskit 2.x circuits
+- 🍎 **Native Apple Silicon** optimization via Metal API
+- 📦 **Simple installation** - no CUDA or complex dependencies
+- ⚛️ **44 quantum gates** supported natively
+
+## Performance
+
+Benchmarked on Apple M2 Pro (16GB RAM):
+
+### Statevector Simulation
+
+| Qubits | Depth | Metal-Q | Qiskit | Speedup |
+|--------|-------|---------|--------|---------|
+| 16 | 10 | 41ms | 42ms | 1.0x |
+| 20 | 10 | 80ms | 1,009ms | **12.7x** |
+| 22 | 10 | 265ms | 4,888ms | **18.5x** |
+| 24 | 8 | 732ms | 17,285ms | **23.6x** |
+| 26 | 6 | 2,303ms | 54,444ms | **23.6x** |
+
+### Sampling (8192 shots)
+
+| Qubits | Metal-Q | Aer | Speedup |
+|--------|---------|-----|---------|
+| 16 | 15ms | 18ms | 1.2x |
+| 20 | 36ms | 138ms | **3.9x** |
+| 22 | 203ms | 497ms | **2.5x** |
+| 24 | 671ms | 1,475ms | **2.2x** |
+
+### QFT Circuit
+
+| Qubits | Metal-Q | Qiskit | Speedup |
+|--------|---------|--------|---------|
+| 16 | 20ms | 24ms | 1.2x |
+| 20 | 63ms | 603ms | **9.6x** |
+| 22 | 137ms | 3,257ms | **23.8x** |
+| 24 | 459ms | 14,788ms | **32.2x** |
+
+## Installation
+
+### Requirements
+
+- macOS 12.0+ (Monterey or later)
+- Apple Silicon (M1/M2/M3/M4) or Intel Mac with Metal support
+- Python 3.9+
+- Xcode Command Line Tools
+
+### Install from Source
+
+```bash
+git clone https://github.com/masa-whitestone/metal-quantum.git
+cd metal-quantum
+make install
+pip install .
+```
+
+## Quick Start
+
+```python
+from qiskit import QuantumCircuit
+import metalq
+
+# Create a quantum circuit (standard Qiskit)
+qc = QuantumCircuit(4, 4)
+qc.h(0)
+qc.cx(0, 1)
+qc.cx(1, 2)
+qc.cx(2, 3)
+qc.measure([0, 1, 2, 3], [0, 1, 2, 3])
+
+# Run on Metal-Q
+result = metalq.run(qc, shots=1024)
+print(result.get_counts())
+# {'0000': 512, '1111': 512}
+```
+
+### Get Statevector
+
+```python
+qc = QuantumCircuit(3)
+qc.h(0)
+qc.cx(0, 1)
+qc.cx(1, 2)
+
+# Get statevector directly
+statevector = metalq.statevector(qc)
+print(statevector)
+# [0.707+0j, 0, 0, 0, 0, 0, 0, 0.707+0j]
+```
+
+## Supported Gates
+
+### Single-Qubit Gates (19)
+`id`, `x`, `y`, `z`, `h`, `s`, `sdg`, `t`, `tdg`, `sx`, `sxdg`, `rx`, `ry`, `rz`, `p`, `u`, `u1`, `u2`, `u3`, `r`
+
+### Two-Qubit Gates (22)
+`cx`, `cy`, `cz`, `ch`, `cs`, `csdg`, `csx`, `cp`, `crx`, `cry`, `crz`, `cu`, `cu1`, `cu3`, `swap`, `iswap`, `dcx`, `ecr`, `rxx`, `ryy`, `rzz`, `rzx`
+
+### Three-Qubit Gates (3)
+`ccx` (Toffoli), `cswap` (Fredkin), `ccz`
+
+### High-Level Constructs
+QFTGate, MCXGate, GroverOperator, UnitaryGate (automatically decomposed)
+
+## API Reference
+
+### `metalq.run(circuit, shots=1024)`
+
+Execute a quantum circuit with measurements.
+
+```python
+result = metalq.run(qc, shots=1024)
+counts = result.get_counts()  # {'00': 523, '11': 501}
+```
+
+### `metalq.statevector(circuit)`
+
+Get the final statevector without measurements.
+
+```python
+sv = metalq.statevector(qc)  # numpy array
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────┐
+│                  Python Layer                    │
+│              (metalq package)                    │
+├─────────────────────────────────────────────────┤
+│                 ctypes Bridge                    │
+├─────────────────────────────────────────────────┤
+│               Native Layer (ObjC)                │
+│             libmetalq.dylib                      │
+├─────────────────────────────────────────────────┤
+│            Metal Compute Shaders                 │
+│          quantum_gates.metallib                  │
+└─────────────────────────────────────────────────┘
+                        │
+                        ▼
+┌─────────────────────────────────────────────────┐
+│              Apple Silicon GPU                   │
+│         (M1 / M2 / M3 / M4 Series)              │
+└─────────────────────────────────────────────────┘
+```
+
+## Limitations
+
+- **macOS only** - Requires Metal API
+- **No noise models** - Pure statevector simulation
+- **Memory bound** - 28 qubits requires ~2GB GPU memory
+
+## Running Tests
+
+```bash
+make install
+pip install pytest qiskit-aer
+pytest tests/ -v
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+Made with ❤️ for the quantum computing community on Apple Silicon.

metalq-0.1.0/README.md

@@ -0,0 +1,181 @@
+# Metal-Q ⚛️🍎
+
+A high-performance quantum circuit simulator for Apple Silicon, using Metal GPU acceleration.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Qiskit 2.x](https://img.shields.io/badge/Qiskit-2.x-6929C4.svg)](https://qiskit.org/)
+
+## Overview
+
+Metal-Q is a drop-in replacement for Qiskit's statevector simulator, optimized for Apple Silicon GPUs. It leverages Metal compute shaders to achieve significant speedups on M1/M2/M3/M4 Macs.
+
+### Key Features
+
+- 🚀 **Up to 32x faster** than Qiskit for large circuits
+- 🔌 **Drop-in compatible** with Qiskit 2.x circuits
+- 🍎 **Native Apple Silicon** optimization via Metal API
+- 📦 **Simple installation** - no CUDA or complex dependencies
+- ⚛️ **44 quantum gates** supported natively
+
+## Performance
+
+Benchmarked on Apple M2 Pro (16GB RAM):
+
+### Statevector Simulation
+
+| Qubits | Depth | Metal-Q | Qiskit | Speedup |
+|--------|-------|---------|--------|---------|
+| 16 | 10 | 41ms | 42ms | 1.0x |
+| 20 | 10 | 80ms | 1,009ms | **12.7x** |
+| 22 | 10 | 265ms | 4,888ms | **18.5x** |
+| 24 | 8 | 732ms | 17,285ms | **23.6x** |
+| 26 | 6 | 2,303ms | 54,444ms | **23.6x** |
+
+### Sampling (8192 shots)
+
+| Qubits | Metal-Q | Aer | Speedup |
+|--------|---------|-----|---------|
+| 16 | 15ms | 18ms | 1.2x |
+| 20 | 36ms | 138ms | **3.9x** |
+| 22 | 203ms | 497ms | **2.5x** |
+| 24 | 671ms | 1,475ms | **2.2x** |
+
+### QFT Circuit
+
+| Qubits | Metal-Q | Qiskit | Speedup |
+|--------|---------|--------|---------|
+| 16 | 20ms | 24ms | 1.2x |
+| 20 | 63ms | 603ms | **9.6x** |
+| 22 | 137ms | 3,257ms | **23.8x** |
+| 24 | 459ms | 14,788ms | **32.2x** |
+
+## Installation
+
+### Requirements
+
+- macOS 12.0+ (Monterey or later)
+- Apple Silicon (M1/M2/M3/M4) or Intel Mac with Metal support
+- Python 3.9+
+- Xcode Command Line Tools
+
+### Install from Source
+
+```bash
+git clone https://github.com/masa-whitestone/metal-quantum.git
+cd metal-quantum
+make install
+pip install .
+```
+
+## Quick Start
+
+```python
+from qiskit import QuantumCircuit
+import metalq
+
+# Create a quantum circuit (standard Qiskit)
+qc = QuantumCircuit(4, 4)
+qc.h(0)
+qc.cx(0, 1)
+qc.cx(1, 2)
+qc.cx(2, 3)
+qc.measure([0, 1, 2, 3], [0, 1, 2, 3])
+
+# Run on Metal-Q
+result = metalq.run(qc, shots=1024)
+print(result.get_counts())
+# {'0000': 512, '1111': 512}
+```
+
+### Get Statevector
+
+```python
+qc = QuantumCircuit(3)
+qc.h(0)
+qc.cx(0, 1)
+qc.cx(1, 2)
+
+# Get statevector directly
+statevector = metalq.statevector(qc)
+print(statevector)
+# [0.707+0j, 0, 0, 0, 0, 0, 0, 0.707+0j]
+```
+
+## Supported Gates
+
+### Single-Qubit Gates (19)
+`id`, `x`, `y`, `z`, `h`, `s`, `sdg`, `t`, `tdg`, `sx`, `sxdg`, `rx`, `ry`, `rz`, `p`, `u`, `u1`, `u2`, `u3`, `r`
+
+### Two-Qubit Gates (22)
+`cx`, `cy`, `cz`, `ch`, `cs`, `csdg`, `csx`, `cp`, `crx`, `cry`, `crz`, `cu`, `cu1`, `cu3`, `swap`, `iswap`, `dcx`, `ecr`, `rxx`, `ryy`, `rzz`, `rzx`
+
+### Three-Qubit Gates (3)
+`ccx` (Toffoli), `cswap` (Fredkin), `ccz`
+
+### High-Level Constructs
+QFTGate, MCXGate, GroverOperator, UnitaryGate (automatically decomposed)
+
+## API Reference
+
+### `metalq.run(circuit, shots=1024)`
+
+Execute a quantum circuit with measurements.
+
+```python
+result = metalq.run(qc, shots=1024)
+counts = result.get_counts()  # {'00': 523, '11': 501}
+```
+
+### `metalq.statevector(circuit)`
+
+Get the final statevector without measurements.
+
+```python
+sv = metalq.statevector(qc)  # numpy array
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────┐
+│                  Python Layer                    │
+│              (metalq package)                    │
+├─────────────────────────────────────────────────┤
+│                 ctypes Bridge                    │
+├─────────────────────────────────────────────────┤
+│               Native Layer (ObjC)                │
+│             libmetalq.dylib                      │
+├─────────────────────────────────────────────────┤
+│            Metal Compute Shaders                 │
+│          quantum_gates.metallib                  │
+└─────────────────────────────────────────────────┘
+                        │
+                        ▼
+┌─────────────────────────────────────────────────┐
+│              Apple Silicon GPU                   │
+│         (M1 / M2 / M3 / M4 Series)              │
+└─────────────────────────────────────────────────┘
+```
+
+## Limitations
+
+- **macOS only** - Requires Metal API
+- **No noise models** - Pure statevector simulation
+- **Memory bound** - 28 qubits requires ~2GB GPU memory
+
+## Running Tests
+
+```bash
+make install
+pip install pytest qiskit-aer
+pytest tests/ -v
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+Made with ❤️ for the quantum computing community on Apple Silicon.

metalq-0.1.0/metalq/python/metalq/__init__.py

@@ -0,0 +1,36 @@
+"""
+Metal-Q: Apple Metal GPU Quantum Circuit Simulator
+"""
+
+from .backend import get_backend, MetalQBackend
+from .result import MetalQResult
+
+__version__ = "0.1.0"
+__all__ = ['run', 'statevector', 'MetalQResult', 'MetalQBackend']
+
+
+def run(circuit, shots: int = 1024) -> MetalQResult:
+    """
+    Run a quantum circuit on the Metal backend.
+    
+    Args:
+        circuit: Qiskit QuantumCircuit
+        shots: Number of shots (default: 1024)
+        
+    Returns:
+        MetalQResult object
+    """
+    return get_backend().run(circuit, shots)
+
+
+def statevector(circuit):
+    """
+    Calculate the statevector of a quantum circuit.
+    
+    Args:
+        circuit: Qiskit QuantumCircuit
+        
+    Returns:
+        numpy.ndarray (complex64)
+    """
+    return get_backend().statevector(circuit)