Skip to main content

Release Platform Python Qiskit

License Downloads Tests Coverage

Shaded lightcones (SLC)

Lightcones

qiskit-addon-slc is a package for computing the shaded lightcone (SLC) [1] of an observable with respect to a quantum circuit. In the context of probabilistic error cancellation (PEC), shaded lightcones are similar to conventional binary lightcones in that not mitigating errors outside the lightcone can reduce the variance (i.e. sampling cost). Lightcone shading allows this strategy to be pushed further by assigning scales to Pauli error generators within the causal lightcone. Errors that are assigned smaller scales have less effect on the observable; truncating them from the noise model can reduce variance (i.e. sampling cost) at the cost of some bias. The qiskit-addon-slc package gives users the ability to do lightcone shading and control the tradeoff between sampling cost and bias.


Documentation

All documentation is available at https://quantum.cloud.ibm.com/docs/addons/qiskit-addon-slc.


Installation

We encourage installing this package via pip, when possible:

pip install qiskit-addon-slc

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][docs/guides/quickstart.ipynb).


Use case examples

This technique has been used to lower the sampling cost of probabilistic error cancellation (PEC) for operator Loschmidt echo experiments with 56 qubits on an IBM Heron processor. [2].


Technical discussion

Method overview

Shaded lightcones are calculated and used in 5 steps:

  1. Compute a bound on the effect of each Pauli error term on the observable at the end of the circuit (forward bound)
  2. Compute a bound on the effect of each Pauli error term on the initial state at the beginning of the circuit (backward bound)

Bounds

  1. Approximate a bias contribution for each Pauli error term using the forward/backward bounds and the term's error rate

Merge bounds

  1. Prioritize error terms based on their error rate and bounds. Truncate terms from the noise model which have the least effect on the observable expectation value until the user-specified bias tolerance is hit. Alternatively, one can add the most impactful error terms to a noise model until the user-specified sampling cost budget is filled.

Prioritize and truncate

  1. Mitigate the truncated noise model. Using the directed execution model from Qiskit Runtime, specifying error terms to ignore during PEC sampling is straightforward. See the tutorial for details.

Reduced PEC

Software features

  • Parallel asynchronous bound computation
  • Rust-accelerated Pauli propagation
  • Rust-accelerated eigenvalue computation for computing forward bounds
  • Permits ahead-of-time bound computation (i.e. prior to the actual noise learning)

Known issues

  • InjectNoise(site="before") not supported
  • Does not support fine-grained bound merging

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] Andrew Eddins, et al., Lightcone shading for classically accelerated quantum error mitigation, arXiv:2409.04401v1 [quant-ph].

[2] Samantha V. Barron et al., Observable Estimation in the Absence of Classical Verification, arXiv:2607.25998 [quant-ph].

Metadata

Release files for qiskit-addon-slc 0.2.0

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-addon-slc 0.2.0
File Size Uploaded Provenance
qiskit_addon_slc-0.2.0.tar.gz 1.8 MB With provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for qiskit-addon-slc 0.2.0
File
qiskit_addon_slc-0.2.0-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details
qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64 Details
qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.28+ ARM64 Details
qiskit_addon_slc-0.2.0-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details
qiskit_addon_slc-0.2.0-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details

Total release size: 3.3 MB

Release files / qiskit_addon_slc-0.2.0.tar.gz

Download URL qiskit_addon_slc-0.2.0.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
c82354a46d64dd4fb7a5fb22742884e911f5d325c69da668b4479664cff11477
BLAKE2b-256 checksum
How to use checksums
b0403ce309bce4e06162b781e41a4b0ea681d9ade44c766b31bcbae2fb04eee2
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 22, 2026.

Transparency log

Release files / qiskit_addon_slc-0.2.0-cp311-abi3-win_amd64.whl

Download URL qiskit_addon_slc-0.2.0-cp311-abi3-win_amd64.whl
Size 245.2 kB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
d8e74c640923299cd77a257a7376662502c2e8ecfdd2943bad710228a7984140
BLAKE2b-256 checksum
How to use checksums
fd1a37c48e9bd6473c7fbcee005b89cdad253f7c337a8d283e3868fe029e8e9a
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 22, 2026.

Transparency log

Release files / qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_x86_64.whl

Download URL qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_x86_64.whl
Size 340.3 kB
Tags CPython 3.11 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
0d5aacbc538642d6d73214ebc37c2b8723e92043d90608b528b177766d314d59
BLAKE2b-256 checksum
How to use checksums
bafd27ac54ce58f48702f5c6316963a77a52b34d5983680ada8330f2f25813f8
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 22, 2026.

Transparency log

Release files / qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_aarch64.whl

Download URL qiskit_addon_slc-0.2.0-cp311-abi3-manylinux_2_28_aarch64.whl
Size 332.7 kB
Tags CPython 3.11 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
5a181900efbdc683c91d1e4f11926fafe813849ebe4d44a3227d0637aa65cc60
BLAKE2b-256 checksum
How to use checksums
828ef14336221838b427253961f8e018e5ba1f349c81b3194716184041901974
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 22, 2026.

Transparency log

Release files / qiskit_addon_slc-0.2.0-cp311-abi3-macosx_11_0_arm64.whl

Download URL qiskit_addon_slc-0.2.0-cp311-abi3-macosx_11_0_arm64.whl
Size 320.1 kB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
b4721e633ab244da8c52ad5d43e4f9e8930498a38d92aa9f5f4d3d945d7aa1e5
BLAKE2b-256 checksum
How to use checksums
0047fab749dfdf9a1081bbc82e5153dec987a3b06a25fdc70514f83be0464503
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 22, 2026.

Transparency log

Release files / qiskit_addon_slc-0.2.0-cp311-abi3-macosx_10_12_x86_64.whl

Download URL qiskit_addon_slc-0.2.0-cp311-abi3-macosx_10_12_x86_64.whl
Size 332.8 kB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
c4009716cb97f77e14fe3d9e5d546e769d1809a98fb090313163e4dffe278e4b
BLAKE2b-256 checksum
How to use checksums
b01169f9eecdae86d31f24b0a14553c03e6b91908e20026590096cc0346dc3c2
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 22, 2026.

Transparency log

Security for qiskit-addon-slc 0.2.0

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_addon_slc-0.2.0.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 22, 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.

Release history Release notifications | RSS feed

This release

0.2.0 This release

6 release files Full provenance

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