Skip to main content

Release Platform Python Qiskit
License Downloads Tests Coverage

Qiskit Paulice

qiskit-paulice is a package for embedding hardware efficient Pauli checks into arbitrary Clifford circuits on arbitrary qubit connectivities using spacetime stabilizer codes. These checks can be used to detect logical errors during circuit execution. Postselecting only samples with no detected errors can improve the fidelity of states sampled with a quantum processor at the cost of some ancilla qubits and an increase in sampling overhead. This method is particularly suited to near-term hardware since it has a much milder overhead in qubits and gates compared to fault tolerant quantum computing, while having a better sampling overhead than error mitigation methods such as ZNE or PEC [1].

Although spacetime Pauli checks may be used to implement standalone error detection routines, they are also relevant in the context of error mitigation and error correction. Error detection can complement error mitigation techniques such as probabilistic error cancellation (PEC) by capturing some of the noise affecting gates and measurements, reducing the impact of the noise channel being inverted and thus reducing the sampling overhead. They may also be viewed as an early step toward practical fault tolerance since implementing stabilizer codes to protect data qubits from logical errors is a core concept of traditional error correction. Since this method provides single shot access to the quantum state it can be used in both sampling-based and expectation value-based workflows.


Documentation

Documentation for this package is available on the IBM Quantum Platform.


Installation

We encourage installing this package via pip, when possible:

pip install 'qiskit-paulice'

For more installation information refer to these installation instructions.


Getting started

A simple guide to help you get started quickly with this package is available here.


Use case examples

This technique has been used to improve the fidelity of samples from Clifford-dominated circuits using 97 physical qubits to encode 2415 logical entangling gates across 70 logical qubits [2].


Technical discussion

Finding good sets of spacetime Pauli checks

Quantum circuit cartoon

A set of spacetime Pauli checks is "good" if each check is valid, low weight, and effective.

A check is comprised of a number of controlled Pauli rotations, $P$, placed on some wires in the circuit, $w$: ${(P_1,w_1), ..., (P_k,w_k)}$. For a given check, the controls lie on a single ancilla qubit, and the rotations occur on wires of a single target qubit. For Clifford circuits, a check is valid if its backpropagated product is a stabilizer of the state prepared by the ideal circuit: $\prod_{i}B(P_i,w_i) \in S$, where $B(P,w)$ is the backpropagator of $P$ from $w$ to the beginning of the circuit, and $S$ is the set of all stabilizers of the circuit.

A check is low weight if it requires few entangling gates to implement. The check picking algorithm will favor checks that are low weight and provide the most effective error detection.

A check is effective if it captures much more error than it introduces. A Pauli check is comprised of a number of entangling gates and thus introduces some additional gate noise into the calculation. It is important to ensure each additional check brings some additional error detection capability. The effectiveness of a set of checks can be approximated by composing the Pauli errors that are uncovered by the checks into a postselected noise channel and calculating its impact. Minimizing the sampling overhead for implementing the uncovered inverse noise channel is a solid heuristic for selecting good checks, as it gives an indication of how much error the checks can't detect. A slower but more realistic approach is to perform a Monte Carlo sampling from the noisy state and empirically compute the logical error rate of the postselected distribution. Both of these approaches are available as built-in cost functions in the qiskit_paulice.add_pauli_checks function.

Postselecting samples based on syndrome data

In this package a check is implemented using entangling gates between one ancilla qubit and one target qubit. Each ancilla starts in $|0\rangle$, so $Z_\text{anc}$ stabilizes its input state. Forward propagating $Z_\text{anc}$ from the beginning of the ancilla through the entire checked circuit yields a Pauli operator on the output which may be higher weight and extend into the payload circuit. The qubit indices on which this output operator has non-identity terms are called the check's support, and the check passes if the bits, $b$, in the check's support have even parity: $\bigoplus_{i=1} b_i = 0$. A sample is kept if each check produces $0$ for its parity check.

Software Features

  • Automatic noise model creation from backend benchmark data
  • Rust accelerated check finding
  • Find checks for a circuit's terminal measurements or for stabilizers of the state it prepares
  • 3 built-in algorithms for check finding
  • Evaluate efficacy of checks based on sampling overhead of postselected inverse noise channel or logical error rate based on Monte Carlo sampling of noisy state
  • Helper functionality for finding ancilla/target qubit pairs for a given backend

Known issues

  • Idling noise is not provided via NoiseModel.get_backend and is ignored during check picking
  • While many stochastic steps in the algorithm are controllable with a random seed, some features have randomness not controllable with a seed. Specifically, the following kwargs values for add_pauli_checks will cause undeterministic check picking: cost="LER", method="genetic", and method="windowed_genetic". For deterministic behavior use: add_pauli_checks(..., cost="gamma", method="windowed"), which are the default values.

Future work

  • Support for handling non-Clifford systems
  • More support for analyzing postselected noise channel
  • Handling idling noise when picking checks
  • Controllable randomness for logical error rate cost function and genetic search algorithms

Contributing

The source code is available on GitHub.

The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.


Citing this package

If you use this package in your research, use the CITATION.bib file in this project’s repository to cite the appropriate reference(s).


License

Apache License 2.0


Deprecation Policy

We follow semantic versioning. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the release notes.


References

[1] Simon Martiel, Ali Javadi-Abhari, Low-overhead error detection with spacetime codes, arXiv:2504.15725 [quant-ph].

[2] Simon Martiel, et al., Sampling hard circuits with verifiably high fidelity, arXiv:2607.25941 [quant-ph].

Metadata

Release files for qiskit-paulice 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qiskit-paulice 0.3
File Size Uploaded Provenance Actions
qiskit_paulice-0.3.tar.gz 1.1 MB With provenance Details for qiskit_paulice-0.3.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for qiskit-paulice 0.3
File Actions
qiskit_paulice-0.3-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for qiskit_paulice-0.3-cp310-abi3-win_amd64.whl
qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.28+ x86-64 Details for qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_x86_64.whl
qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.28+ ARM64 Details for qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_aarch64.whl
qiskit_paulice-0.3-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for qiskit_paulice-0.3-cp310-abi3-macosx_11_0_arm64.whl
qiskit_paulice-0.3-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details for qiskit_paulice-0.3-cp310-abi3-macosx_10_12_x86_64.whl

Total release size: 4.1 MB

Release files / qiskit_paulice-0.3.tar.gz

Download URL qiskit_paulice-0.3.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
3999c7df971c4c3f8b2cc92e8f2a273a9aeed6f9d6da83f64041da23498655a3
BLAKE2b-256 checksum
How to use checksums
d23865df2938c4e745c6a805c9774ee95b5c6f6082a20549f9b5101b6c806837
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / qiskit_paulice-0.3-cp310-abi3-win_amd64.whl

Download URL qiskit_paulice-0.3-cp310-abi3-win_amd64.whl
Size 473.7 kB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
f37de02abf5d8000cad11c346cc6d493d5f88c10ef17fc31ea4bcf949f99ca63
BLAKE2b-256 checksum
How to use checksums
296a03d939e74c35189c91fe48a64e78d8278857ffbaa844a7f0b9be8476cbaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_x86_64.whl
Size 656.0 kB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
edffefe2b1ec7f52e2f948e0df56e2a180510e6a5ad9484c7791c8efc496a541
BLAKE2b-256 checksum
How to use checksums
87220f20a796717d39fdf56cd25c38fafba6337022c3d29f15d53039eb467c7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL qiskit_paulice-0.3-cp310-abi3-manylinux_2_28_aarch64.whl
Size 631.7 kB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
aa310dd030d95321b9acf73a9789bf147b7c45bf50949fa66b0df6a173442c9f
BLAKE2b-256 checksum
How to use checksums
30923cfda81aa4e8bbe9a065c5d59976a4febacfbeb52e2b9aa1059ab4bc9c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / qiskit_paulice-0.3-cp310-abi3-macosx_11_0_arm64.whl

Download URL qiskit_paulice-0.3-cp310-abi3-macosx_11_0_arm64.whl
Size 576.2 kB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
c4e20bf0ef3c9b62922368cbd8fd03cc68f2bbd8f2af2913b1c6f82789d0ce05
BLAKE2b-256 checksum
How to use checksums
908b3403f5e5427cdf80272ac859c8712e16d414b278f31568907ee30a80671f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / qiskit_paulice-0.3-cp310-abi3-macosx_10_12_x86_64.whl

Download URL qiskit_paulice-0.3-cp310-abi3-macosx_10_12_x86_64.whl
Size 593.0 kB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
2d774d1feb6e42c8ed1fd686e525762a1cf5fa1f01c4074722c50d0169579c60
BLAKE2b-256 checksum
How to use checksums
4eba7943564fbe2eb4bd562165626896add3561b91e997adcda96bc6977a8c4a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for qiskit-paulice 0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for qiskit_paulice-0.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page