Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Welcome to Qamomile Documentation

Qamomile (pronounced /ˈkæməˌmiːl/, like “chamomile”) is named after the chamomile flower — a symbol of calm and clarity.

Qamomile is a quantum programming SDK. Write quantum circuits as typed Python functions and run them on quantum SDKs like Qiskit, CUDA-Q, QURI Parts, and qBraid. Furthermore, Qamomile supports symbolic algebraic resource estimation and can estimate resources for circuits containing black-box oracles — even when the circuit itself cannot be executed.

Installation

pip install qamomile

Supported Quantum SDKs

Qamomile supports multiple quantum SDKs as execution backends. Qiskit is included by default; the others are optional extras.

Qiskit (default)

Included with pip install qamomile. No extra flags needed.

from qamomile.qiskit import QiskitTranspiler, QiskitExecutor

CUDA-Q (optional)

CUDA-Q supports Linux and macOS ARM64 (Apple Silicon). Choose the extra that matches your CUDA version:

pip install "qamomile[cudaq-cu12]"   # CUDA 12.x, Linux
pip install "qamomile[cudaq-cu13]"   # CUDA 13.x, Linux or macOS ARM64
from qamomile.cudaq import CudaqTranspiler, CudaqExecutor

QURI Parts (optional)

pip install "qamomile[quri_parts]"
from qamomile.quri_parts import QuriPartsTranspiler, QuriPartsExecutor

qBraid (optional)

Runs Qiskit circuits on qBraid-supported devices and simulators.

pip install "qamomile[qbraid]"
from qamomile.qbraid import QBraidExecutor

Sections

For SDK-level fundamentals (kernels, parameters, execution, transpilation, QEC primitives), see the Tutorials section.