Skip to main content
Version: master

Getting Started with Qumat

Installation​

Install Qumat from PyPI:

pip install qumat

Install with QDP (Quantum Data Plane) support:

pip install qumat[qdp]

From Source (Development)​

For development or the latest changes, use uv:

git clone https://github.com/apache/mahout.git
cd mahout
pip install uv
uv sync                     # Core Qumat
uv sync --extra qdp         # With QDP (requires NVIDIA GPU + CUDA)

:::note Why uv? The project uses uv to handle dependency overrides required for Python 3.10+ compatibility with some backend dependencies. :::

Basic Usage​

from qumat import QuMat

qumat = QuMat({
    "backend_name": "qiskit",
    "backend_options": {"simulator_type": "aer_simulator"},
})
qumat.create_empty_circuit(num_qubits=2)
qumat.apply_hadamard_gate(0)
qumat.apply_cnot_gate(0, 1)
result = qumat.execute_circuit()
print(result)

Dependencies​

Prior to installation, ensure Python 3.10-3.12 is installed. Dependencies such as Qiskit, Cirq, and Amazon Braket SDK are managed automatically.

Apache Release​

Official source releases are available at apache.org/dist/mahout.

To verify the integrity of a downloaded release:

gpg --import KEYS
gpg --verify mahout-qumat-0.5.zip.asc mahout-qumat-0.5.zip

Examples​

Refer to repository examples:

  • examples/Simple_Example.ipynb
  • examples/Optimization_Example.ipynb

Next Steps​