Skip to main content

A hardware-agnostic Python library for qutrit (3-level) quantum computing: gates, circuits, simulation, and SU(3) decomposition.

Project description

Tests Unitary Fund License: MIT Python 3.10+

Qutritium

A hardware-agnostic Python library for qutrit quantum computing.

Build, simulate, and decompose three-level quantum circuits.


Installation

pip install qutritium            # release
pip install -e ".[dev]"          # editable + dev tools

Quick Start

from qutritium import QutritCircuit, QASMSimulator
from qutritium.gates import H3, CSUM
import numpy as np

# Qutrit Bell state: H3 + CSUM → (|00⟩ + |11⟩ + |22⟩) / √3
qc = QutritCircuit(2, None)
qc.append(H3(), first_qutrit=0)
qc.append(CSUM(), first_qutrit=0, second_qutrit=1)
qc.measure_all()

sim = QASMSimulator(qc)
sim.run(num_shots=10_000)
print(sim.get_counts())   # {'00': ~3333, '11': ~3333, '22': ~3333}

Decompose an arbitrary SU(3) unitary:

from qutritium import SU3Decomposition
import numpy as np

U = ...  # any 3×3 unitary
dec = SU3Decomposition(U, qutrit_index=0, n_qutrits=1)
print(dec.angles)  # nine decomposition angles
print(dec.reconstruct())  # ≈ U to machine precision

Gate Library

Single-qutrit gates

Category Gates
Pauli-X X01, X02, X12
Pauli-Y Y01, Y02, Y12
Pauli-Z Z01, Z02, Z12
Shifts XPlus (cyclic), XMinus (inverse)
Discrete H3 (Hadamard/DFT), S3, T3, UFT, I3
Rotations Rx01, Rx02, Rx12, Ry01, Ry02, Ry12, Rz01, Rz02, Rz12
Generalized G01(θ,φ), G02(θ,φ), G12(θ,φ) — native trapped-ion gate
Diagonal Ud(φ₁,φ₂,φ₃) — virtual-Z in hardware

Two-qutrit gates

Gate Action
CSUM |c,t⟩ → |c, (t+c) mod 3⟩
CSUMDag |c,t⟩ → |c, (t−c) mod 3⟩ (CSUM inverse)
CPhase |c,t⟩ → ω^{c·t} |c,t⟩
SWAP3 |a,b⟩ → |b,a⟩
CNOT3 Legacy v0.0.1 CNOT (= CSUM on adjacent qutrits)

All gates inherit from Gate and provide .matrix(), .inverse(), .is_unitary(), .label, .params.

Package Structure

src/qutritium/
├── gates/               # Gate objects
│   ├── base.py          #   Gate ABC + _DaggerGate
│   ├── single_qutrit.py #   29 single-qutrit gates
│   └── two_qutrit.py    #   5 two-qutrit gates
├── circuit/             # Circuit infrastructure
│   ├── elementary_matrices.py  # Raw 3×3 / 9×9 unitaries
│   ├── instruction.py          # Instruction + GATE_SET
│   ├── qutrit_circuit.py       # QutritCircuit container
│   └── utils.py                # Statevector utilities
├── simulator/           # QASMSimulator (statevector)
└── decomposition/       # SU(3) → native rotations

Supporting files at repo root:

.github/workflows/       # CI (test.yml, docs.yml)
docs/                    # MkDocs source → spham1611.github.io/qutritium
examples/tutorial.ipynb  # End-to-end Bell state tutorial
test/                    # pytest suite (168 tests)
legacy/                  # v0.0.x Qiskit-pulse code (archived, not installed)

Documentation

Full docs: https://spham1611.github.io/qutritium/

Tutorial notebook: examples/tutorial.ipynb

History

Qutritium was originally built for calibrating qutrits on IBM superconducting hardware, presented at the Munich Quantum Software Conference 2023 and funded by a Unitary Fund microgrant. The v1.0.0 release pivoted to a hardware-agnostic library; the original pulse code is preserved under legacy/.

Authors

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qutritium-1.3.0.tar.gz (34.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qutritium-1.3.0-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file qutritium-1.3.0.tar.gz.

File metadata

  • Download URL: qutritium-1.3.0.tar.gz
  • Upload date:
  • Size: 34.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qutritium-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bd0bb3d942f0b785525b6c315a43743937abb44cb9db6827cb5ecadd479289c2
MD5 c5058c7c8d791eab4e523b327f3eaa42
BLAKE2b-256 843c035d96d4f3a59bee2977fb633aeca1ce10dbd8a33aadda111c9adea8c898

See more details on using hashes here.

Provenance

The following attestation bundles were made for qutritium-1.3.0.tar.gz:

Publisher: release.yml on spham1611/qutritium

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qutritium-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: qutritium-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qutritium-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6230d9f00f1e1b8111d42c7bf06f7031aa0e27110f56d8efedbcbcea848391bb
MD5 cd2bf3804f0ff8247263c4b0aa42cfba
BLAKE2b-256 42bfec73654d994bdfaec341879abf28f39649607fa0f0d0a1a02aae89df0512

See more details on using hashes here.

Provenance

The following attestation bundles were made for qutritium-1.3.0-py3-none-any.whl:

Publisher: release.yml on spham1611/qutritium

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page