Qiskit Aer Encore

Aer simulators configured for the available hardware, used by the tests of this monorepo.

Installation

pip install qiu-qiskit-aer-encore

Usage

simulator.aer_simulator(device=..., **options) returns an AerSimulator on the requested AerDevice:

On GPUs, the simulator uses Nvidia's cuStateVec library and distributes the simulation and the shots over all available devices (GPU_OPTIONS). Further keyword options are passed on to AerSimulator, overriding these defaults. The available devices are detected once, see available_aer_devices().

from qiskit import QuantumCircuit, transpile
from qiu_qiskit_aer_encore.simulator import aer_simulator

circuit = QuantumCircuit(2)
circuit.h(0)
circuit.cx(0, 1)
circuit.measure_all()

simulator = aer_simulator(device="cpu", method="statevector")
counts = simulator.run(transpile(circuit, simulator), shots=100).result().get_counts()
assert set(counts) <= {"00", "11"}

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-aer-encore/. To serve it locally, from the repository root:

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

Tests

From the repository root:

uv run pytest packages/qiu-qiskit-aer-encore

The GPU paths are tested with a faked device list, so the tests also run without a GPU.