Qiu Qiskit Encore

Improvements of the native types of Qiskit, used by the other packages of this monorepo: statevectors validated as normalized states of qubits, and the synthesis methods choosing how a circuit building block is represented in a circuit. The contributors to this package believe that such tools should be part of the standard Qiskit library, or at least they can envision them being so. The circuit building blocks themselves, e.g. state preparation and the QFT, are in qiu-quantum-computing.

Installation

pip install qiu-qiskit-encore

Validated statevectors

statevector.validated_statevector(state) returns a copy of a Qiskit Statevector, or of amplitudes, as a complex Statevector, and raises a ValueError unless its dimension is a power of 2 of at least one qubit and it is normalized up to Qiskit's tolerances. States are never normalized silently.

Synthesis methods

synthesis_method.SynthesisMethod chooses how a circuit building block is represented in its circuit, by a method parameter:

It is an ExtendedEnum of qiu-python-encore, so its members compare equal to their raw values "dense", "gate" and "decomposed".

Usage

import numpy as np
from qiskit.quantum_info import Statevector
from qiu_qiskit_encore.statevector import validated_statevector
from qiu_qiskit_encore.synthesis_method import SynthesisMethod

# a copy of the amplitudes as a statevector, checked to be a normalized state of qubits
statevector = validated_statevector(np.array([0.6, 0.8j]))
assert statevector == Statevector([0.6, 0.8j])

# the synthesis methods compare equal to, and are constructed from, their raw values
assert SynthesisMethod("decomposed") is SynthesisMethod.DECOMPOSED
assert SynthesisMethod.GATE == "gate"

Documentation

The documentation, with the API reference from the docstrings, is built from docs/ with MkDocs and published at https://blackwild.github.io/qiu/qiu-qiskit-encore/. To serve it locally, from the repository root:

uv run mkdocs serve -f packages/qiu-qiskit-encore/mkdocs.yml

Tests

From the repository root:

uv run pytest packages/qiu-qiskit-encore