Metadata-Version: 2.4
Name: mklq
Version: 0.1.0
Summary: MKL-Q Python runtime for CUDA-Q-compatible Apple Silicon simulation.
Keywords: mklq,cudaq,apple-silicon,metal,quantum,quantum computing
Author: MKL-Q contributors
Maintainer: MKL-Q contributors
License-Expression: Apache-2.0
License-File: CITATION.cff
License-File: LICENSE
License-File: NOTICE
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/wuls968/MKL-Q
Project-URL: Documentation, https://github.com/wuls968/MKL-Q/tree/main/docs/mklq
Project-URL: Repository, https://github.com/wuls968/MKL-Q
Project-URL: Releases, https://github.com/wuls968/MKL-Q/releases
Requires-Python: <3.15,>=3.11
Requires-Dist: astpretty~=3.0
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10.1
Requires-Dist: requests>=2.32.3
Provides-Extra: chemistry
Requires-Dist: openfermionpyscf==0.5; python_version < "3.14" and extra == "chemistry"
Requires-Dist: h5py<3.11; python_version < "3.14" and extra == "chemistry"
Provides-Extra: visualization
Requires-Dist: qutip>5; extra == "visualization"
Requires-Dist: matplotlib>=3.5; extra == "visualization"
Provides-Extra: integrators
Requires-Dist: torchdiffeq; extra == "integrators"
Description-Content-Type: text/markdown

# MKL-Q Python Runtime

`mklq` is the macOS ARM64 Python runtime for MKL-Q, a CUDA-Q-compatible Apple
Silicon simulator fork. Its public Python import remains `cudaq`.

## Supported scope

- macOS ARM64 only.
- Python 3.11–3.14.
- Stable local target: `mklq-cpu`.
- Experimental mixed-path target: `mklq-metal`.

The wheel provides the Python runtime and target assets only. It does not
include `nvq++`, an installer, CUDA GPU support, or a claim that all execution
remains on Metal.

## Installation

Install into an isolated virtual environment. `mklq` cannot safely coexist with
NVIDIA `cudaq` or `cuda-quantum*` distributions because they all own the
`cudaq` import namespace.

```bash
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install mklq
```

## Smoke test

```python
import cudaq

@cudaq.kernel
def bell():
    qubits = cudaq.qvector(2)
    h(qubits[0])
    x.ctrl(qubits[0], qubits[1])
    mz(qubits)

cudaq.set_target("mklq-cpu")
print(cudaq.sample(bell, shots_count=100))
```

For source builds, C++ compilation, and current limitations, see
<https://github.com/wuls968/MKL-Q>.
