Metadata-Version: 2.4
Name: quantum-pecos
Version: 0.8.0.dev7
Summary: PECOS is a library for the evaluation, study, and design of quantum error correction protocols.
Project-URL: documentation, https://quantum-pecos.readthedocs.io
Project-URL: repository, https://github.com/PECOS-packages/PECOS
Author: The PECOS Developers
Maintainer-email: Ciaran Ryan-Anderson <ciaranra@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "{}"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
        
           Copyright {yyyy} {name of copyright owner}
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
License-File: NOTICE
Keywords: PECOS,QEC,quantum,simulation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: guppylang>=0.21.6
Requires-Dist: hugr>=0.13.0
Requires-Dist: networkx>=2.1.0
Requires-Dist: pecos-rslib==0.8.0.dev7
Requires-Dist: phir>=0.3.3
Requires-Dist: selene-sim~=0.2.0
Provides-Extra: all
Requires-Dist: matplotlib>=2.2.0; extra == 'all'
Requires-Dist: plotly~=5.9.0; extra == 'all'
Requires-Dist: stim>=1.12.0; extra == 'all'
Provides-Extra: cuda
Requires-Dist: cupy-cuda13x>=13.0.0; (python_version >= '3.11') and extra == 'cuda'
Requires-Dist: cuquantum-python-cu13>=25.3.0; (python_version >= '3.11') and extra == 'cuda'
Requires-Dist: pecos-rslib-cuda==0.8.0.dev7; extra == 'cuda'
Requires-Dist: pytket-cutensornet>=0.12.0; (python_version >= '3.11') and extra == 'cuda'
Provides-Extra: stim
Requires-Dist: stim>=1.12.0; extra == 'stim'
Provides-Extra: visualization
Requires-Dist: matplotlib>=2.2.0; extra == 'visualization'
Requires-Dist: plotly~=5.9.0; extra == 'visualization'
Description-Content-Type: text/markdown

# ![PECOS](images/pecos_logo.svg)

[![PyPI version](https://badge.fury.io/py/quantum-pecos.svg)](https://badge.fury.io/py/quantum-pecos)
[![Documentation Status](https://readthedocs.org/projects/quantum-pecos/badge/?version=latest)](https://quantum-pecos.readthedocs.io/en/latest/?badge=latest)
[![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue.svg)](https://img.shields.io/badge/python-3.9%2C%203.10%2C%203.11-blue.svg)
[![Supported by Quantinuum](https://img.shields.io/badge/supported_by-Quantinuum-blue)](https://www.quantinuum.com/)

**Performance Estimator of Codes On Surfaces (PECOS)** is a library/framework dedicated to the study, development, and
evaluation of quantum error-correction protocols. It also offers tools for the study and evaluation of hybrid
quantum/classical compute execution models.

Initially conceived and developed in 2014 to verify lattice-surgery procedures presented in
[arXiv:1407.5103](https://arxiv.org/abs/1407.5103) and released publicly in 2018, PECOS filled the gap in
the QEC/QC tools available at that time. Over the years, it has grown into a framework for studying general QECCs and
hybrid computation.

## Features

- Quantum Error-Correction Tools: Advanced tools for studying quantum error-correction protocols and error models.
- Hybrid Quantum/Classical Execution: Evaluate advanced hybrid compute models, including support for classical compute,
calls to Wasm VMs, conditional branching, and more.
- Fast Simulation: Leverages a fast stabilizer simulation algorithm.
- Multi-language extensions: Core functionalities implemented via Rust for performance and safety. Additional add-ons
and extension support in C/C++ via Cython.
- LLVM IR Support: Execute LLVM Intermediate Representation programs for hybrid quantum/classical computing. LLVM support is optional - PECOS can be built without LLVM by using `--no-default-features` when building the Rust crates. When LLVM is enabled (default), requires LLVM version 14.

## Getting Started

Explore the capabilities of PECOS by delving into the [documentation](https://quantum-pecos.readthedocs.io).

## Repository Structure

PECOS now consists of multiple interconnected components:

- `/python/`: Contains Python packages
  - `/python/quantum-pecos/`: Main Python package (imports as `pecos`)
  - `/python/pecos-rslib/`: Python package with Rust extensions that utilize the `pecos` crate
- `/crates/`: Contains Rust crates
  - `/crates/pecos/`: Main Rust crate that collects the functionality of the other crates into one library
  - `/crates/pecos-core/`: Core Rust functionalities
  - `/crates/pecos-qsims/`: A collection of quantum simulators
  - `/crates/pecos-qec/`: Rust code for analyzing and exploring quantum error correction (QEC)
  - `/crates/pecos-qasm/`: Implementation of QASM parsing and execution
  - `/crates/pecos-llvm-runtime/`: Implementation of LLVM IR execution for hybrid quantum-classical programs
  - `/crates/pecos-engines/`: Quantum and classical engines for simulations
  - `/crates/pecos/`: Main PECOS library (includes CLI with `cli` feature)
  - `/crates/pecos-build/`: Developer tools CLI (LLVM setup, dependency management)
  - `/crates/pecos-python/`: Rust code for Python extensions
  - `/crates/benchmarks/`: A collection of benchmarks to test the performance of the crates
- `/julia/`: Contains Julia packages (experimental)
  - `/julia/PECOS.jl/`: Main Julia package
  - `/julia/pecos-julia-ffi/`: Rust FFI library for Julia bindings

### Quantum Error Correction Decoders

PECOS includes LDPC (Low-Density Parity-Check) quantum error correction decoders as optional components. See [DECODERS.md](DECODERS.md) for detailed information about:
- LDPC decoder algorithms and variants
- How to build and use decoders
- Performance considerations
- Architecture and development guide

You may find most of these crates in crates.io if you wish to utilize only a part of PECOS, e.g., the simulators.

## Versioning

We follow semantic versioning principles. However, before version 1.0.0, the MAJOR.MINOR.BUG format sees the roles
of MAJOR and MINOR shifted down a step. This means potential breaking changes might occur between MINOR increments, such
as moving from versions 0.1.0 to 0.2.0.

All Python packages and all Rust crates will have the same version amongst their
respective languages; however, Python and Rust versioning will differ.

## Latest Development

Stay updated with the latest developments on the
[PECOS Development branch](https://quantum-pecos.readthedocs.io/en/development/).

## Installation

### Python Package

To install the main Python package for general usage:

```sh
pip install quantum-pecos
```

This will install both `quantum-pecos` and its dependency `pecos-rslib`.

For optional dependencies:

```sh
pip install quantum-pecos[all]
```

**NOTE:** The `quantum-pecos` package is imported like: `import pecos` and not `import quantum_pecos`.

**NOTE:** To install pre-releases (the latest development code) from pypi you may have to specify the version you are
interested like so (e.g., for version `0.6.0.dev5`):
```sh
pip install quantum-pecos==0.6.0.dev5
```

**NOTE:** Certain simulators have special requirements and are not installed by the command above. Installation instructions for
these are provided [here](#simulators-with-special-requirements).


### Rust Crates

To use PECOS in your Rust project, add the following to your `Cargo.toml`:

```toml
[dependencies]
pecos = "0.x.x"  # Replace with the latest version
```

#### Optional Dependencies

- **LLVM version 14**: Required for LLVM IR execution support (optional)

  PECOS provides an automated installer or you can install manually:

  ```sh
  # Quick setup with automated installer (recommended):
  cargo run -p pecos --features cli -- install llvm
  cargo build
  ```

  The installer automatically configures PECOS after installation.

  For detailed LLVM installation instructions for all platforms (macOS, Linux, Windows), see the [**Getting Started Guide**](docs/user-guide/getting-started.md#llvm-for-qis-support).

  For full development environment setup, see the [**Development Setup Guide**](docs/development/DEVELOPMENT.md).

  **Building without LLVM:** If you don't need LLVM IR support:
  ```sh
  cargo build --no-default-features
  ```

### Julia Package (Experimental)

PECOS also provides experimental Julia bindings. To use the Julia package from the development branch:

```julia
using Pkg
Pkg.add(url="https://github.com/PECOS-packages/PECOS#dev", subdir="julia/PECOS.jl")
```

Then you can use it:

```julia
using PECOS
println(pecos_version())  # Prints PECOS version
```

**Note**: The Julia package requires the Rust FFI library to be built. Currently, you need to build it locally:
1. Clone the repository
2. Build the FFI library: `cd julia/pecos-julia-ffi && cargo build --release`
3. Add the package locally: `Pkg.develop(path="julia/PECOS.jl")`

## Development Setup

If you are interested in editing or developing the code in this project, see this
[development documentation](docs/development/DEVELOPMENT.md) to get started.

## Simulators with special requirements

Certain simulators from `pecos.simulators` require external packages that are not installed by `pip install .[all]`.

### GPU-Accelerated Simulators (CuStateVec and MPS)

- **`CuStateVec`** and **`MPS`** require:
  - Linux machine with NVIDIA GPU (Compute Capability 7.0+)
  - CUDA Toolkit 13 or 12 (system-level installation)
  - Python packages: `cupy-cuda13x`, `cuquantum-python-cu13`, `pytket-cutensornet`

**Installation:** See the comprehensive [CUDA Setup Guide](docs/user-guide/cuda-setup.md) for detailed step-by-step instructions.

**Quick install** (after installing CUDA Toolkit):
```bash
uv pip install quantum-pecos[cuda]

# For development with CUDA support:
make build-cuda  # Build with CUDA
make devc        # Full dev cycle (clean + build-cuda + test)
make devcl       # Dev cycle + linting
```

**Note:** When using `uv` or `pip`, install CUDA Toolkit via system package manager (e.g., `sudo apt install cuda-toolkit-13`), then install Python packages. Conda environments may conflict with `uv`/`venv` workflows.

## Uninstall

To uninstall:

```sh
pip uninstall quantum-pecos
```

## Citing

For publications utilizing PECOS, kindly cite PECOS such as:

```bibtex
@misc{pecos,
 author={Ciar\'{a}n Ryan-Anderson},
 title={PECOS: Performance Estimator of Codes On Surfaces},
 publisher = {GitHub},
 journal = {GitHub repository},
 howpublished={\url{https://github.com/PECOS-packages/PECOS}},
 URL = {https://github.com/PECOS-packages/PECOS},
 year={2018}
}
```
And/or the PhD thesis PECOS was first described in:
```bibtex
@phdthesis{crathesis,
 author={Ciar\'{a}n Ryan-Anderson},
 school = {University of New Mexico},
 title={Quantum Algorithms, Architecture, and Error Correction},
 journal={arXiv:1812.04735},
 URL = {https://digitalrepository.unm.edu/phyc_etds/203},
 year={2018}
}
```

You can also use the [Zenodo DOI](https://zenodo.org/records/13700104), which would result in a bibtex like:
```bibtex
@software{pecos_[year],
  author       = {Ciar\'{a}n Ryan-Anderson},
  title        = {PECOS-packages/PECOS: [version]]},
  month        = [month],
  year         = [year],
  publisher    = {Zenodo},
  version      = {[version]]},
  doi          = {10.5281/zenodo.13700104},
  url          = {https://doi.org/10.5281/zenodo.13700104}
}
```


## License

This project is licensed under the Apache-2.0 License - see the [LICENSE](./LICENSE) and [NOTICE](NOTICE) files for
details.

## Supported by

[![Quantinuum](./images/Quantinuum_(word_trademark).svg)](https://www.quantinuum.com/)
