Metadata-Version: 2.4
Name: qiskit-addon-slc
Version: 0.1.0
Summary: Reducing PEC sampling overhead with shaded lightcones
License-Expression: Apache-2.0
License-File: LICENSE.txt
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: matplotlib<4,>=3.10.5
Requires-Dist: pauli-prop~=0.1.0
Requires-Dist: pyscf<3,>=2.10
Requires-Dist: qiskit<3,>=2.2
Requires-Dist: rustworkx
Requires-Dist: samplomatic>=0.10.1
Provides-Extra: basetest
Requires-Dist: pytest-cov>=5.0; extra == 'basetest'
Requires-Dist: pytest-subtests>=0.14; extra == 'basetest'
Requires-Dist: pytest>=8.0; extra == 'basetest'
Provides-Extra: dev
Requires-Dist: jupyter-sphinx; extra == 'dev'
Requires-Dist: mypy==1.18.2; extra == 'dev'
Requires-Dist: nbmake>=1.5.0; extra == 'dev'
Requires-Dist: nbqa>=1.8.5; extra == 'dev'
Requires-Dist: nbsphinx>=0.9.4; extra == 'dev'
Requires-Dist: pylint==4.0.2; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest-doctestplus>=1.2.1; extra == 'dev'
Requires-Dist: pytest-subtests>=0.14; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: qiskit-ibm-runtime; extra == 'dev'
Requires-Dist: qiskit-sphinx-theme~=2.0.0; extra == 'dev'
Requires-Dist: reno>=4.1; extra == 'dev'
Requires-Dist: ruff==0.14.3; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints; extra == 'dev'
Requires-Dist: sphinx-copybutton; extra == 'dev'
Requires-Dist: sphinx-design; extra == 'dev'
Requires-Dist: sphinx-reredirects; extra == 'dev'
Requires-Dist: toml>=0.9.6; extra == 'dev'
Requires-Dist: tox>=4.4.3; extra == 'dev'
Requires-Dist: typos>=1.20.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: jupyter-sphinx; extra == 'docs'
Requires-Dist: nbsphinx>=0.9.4; extra == 'docs'
Requires-Dist: pytest-cov>=5.0; extra == 'docs'
Requires-Dist: pytest-doctestplus>=1.2.1; extra == 'docs'
Requires-Dist: pytest-subtests>=0.14; extra == 'docs'
Requires-Dist: pytest>=8.0; extra == 'docs'
Requires-Dist: qiskit-sphinx-theme~=2.0.0; extra == 'docs'
Requires-Dist: reno>=4.1; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Requires-Dist: sphinx-reredirects; extra == 'docs'
Provides-Extra: doctest
Requires-Dist: pytest-cov>=5.0; extra == 'doctest'
Requires-Dist: pytest-doctestplus>=1.2.1; extra == 'doctest'
Requires-Dist: pytest-subtests>=0.14; extra == 'doctest'
Requires-Dist: pytest>=8.0; extra == 'doctest'
Provides-Extra: lint
Requires-Dist: mypy==1.18.2; extra == 'lint'
Requires-Dist: nbqa>=1.8.5; extra == 'lint'
Requires-Dist: pylint==4.0.2; extra == 'lint'
Requires-Dist: reno>=4.1; extra == 'lint'
Requires-Dist: ruff==0.14.3; extra == 'lint'
Requires-Dist: toml>=0.9.6; extra == 'lint'
Requires-Dist: typos>=1.20.0; extra == 'lint'
Provides-Extra: nbtest
Requires-Dist: nbmake>=1.5.0; extra == 'nbtest'
Requires-Dist: pytest-cov>=5.0; extra == 'nbtest'
Requires-Dist: pytest-subtests>=0.14; extra == 'nbtest'
Requires-Dist: pytest>=8.0; extra == 'nbtest'
Provides-Extra: notebook-dependencies
Provides-Extra: style
Requires-Dist: nbqa>=1.8.5; extra == 'style'
Requires-Dist: ruff==0.14.3; extra == 'style'
Requires-Dist: typos>=1.20.0; extra == 'style'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest-subtests>=0.14; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Requires-Dist: qiskit-ibm-runtime; extra == 'test'
Description-Content-Type: text/markdown

<!-- SHIELDS -->
<div align="left">

  [![Release](https://img.shields.io/pypi/v/qiskit-addon-slc.svg?label=Release)](https://github.com/Qiskit/qiskit-addon-slc/releases)
  ![Platform](https://img.shields.io/badge/%F0%9F%92%BB%20Platform-Linux%20%7C%20macOS-informational)
  [![Python](https://img.shields.io/pypi/pyversions/qiskit-addon-slc?label=Python&logo=python)](https://www.python.org/)
  [![Qiskit](https://img.shields.io/badge/Qiskit%20-%20%3E%3D2.2%20-%20%236133BD?logo=Qiskit)](https://github.com/Qiskit/qiskit)
<br />
  [![Docs (stable)](https://img.shields.io/badge/%F0%9F%93%84%20Docs-stable-blue.svg)](https://qiskit.github.io/qiskit-addon-slc/)
  <!--[![DOI](https://zenodo.org/badge/TODO.svg)](https://zenodo.org/badge/latestdoi/TODO)-->
  [![License](https://img.shields.io/github/license/Qiskit/qiskit-addon-slc?label=License)](LICENSE.txt)
  [![Downloads](https://img.shields.io/pypi/dm/qiskit-addon-slc.svg?label=Downloads)](https://pypi.org/project/qiskit-addon-slc/)
  [![Tests](https://github.com/Qiskit/qiskit-addon-slc/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/Qiskit/qiskit-addon-slc/actions/workflows/test_latest_versions.yml)
  [![Coverage](https://coveralls.io/repos/github/Qiskit/qiskit-addon-slc/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-addon-slc?branch=main)
</div>

# Qiskit addon: shaded lightcones (SLC)

### Table of contents

* [About](#about)
* [Documentation](#documentation)
* [Installation](#installation)
* [Deprecation Policy](#deprecation-policy)
* [Contributing](#contributing)
* [License](#license)
* [References](#references)

----------------------------------------------------------------------------------------------------

### About

[Qiskit addons](https://quantum.cloud.ibm.com/docs/guides/addons) are a collection of modular tools for building utility-scale workloads powered by Qiskit.

This package contains the Qiskit addon for shaded lightcones (SLC).
These can be used to reduce the sampling overhead of PEC.

----------------------------------------------------------------------------------------------------

### Documentation

All documentation is available at https://qiskit.github.io/qiskit-addon-slc/.

----------------------------------------------------------------------------------------------------

### Installation

We encourage installing this package via `pip`, when possible:

```bash
pip install qiskit-addon-slc
```

For more installation information refer to these [installation instructions](docs/install.rst).

----------------------------------------------------------------------------------------------------

### Deprecation Policy

We follow [semantic versioning](https://semver.org/) and are guided by the principles in
[Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).
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](https://qiskit.github.io/qiskit-addon-slc/release-notes.html).

----------------------------------------------------------------------------------------------------

### Contributing

The source code is available [on GitHub](https://github.com/Qiskit/qiskit-addon-slc).

The developer guide is located at [CONTRIBUTING.md](https://github.com/Qiskit/qiskit-addon-slc/blob/main/CONTRIBUTING.md)
in the root of this project's repository.
By participating, you are expected to uphold Qiskit's [code of conduct](https://github.com/Qiskit/qiskit/blob/main/CODE_OF_CONDUCT.md).

We use [GitHub issues](https://github.com/Qiskit/qiskit-addon-slc/issues/new/choose) for tracking requests and bugs.

----------------------------------------------------------------------------------------------------

### References

1. A. Eddins, et al. [Lightcone shading for classically accelerated quantum error mitigation](https://arxiv.org/abs/2409.04401v1), arXiv:2409.04401v1 [quant-ph].

----------------------------------------------------------------------------------------------------

### License

[Apache License 2.0](LICENSE.txt)
