planqtn 0.1.0
PlanqTN is a tensor network quantum error correction library implementation of the quantum LEGO framework.
Requires Python: >=3.9

<p align="center">
<img src="docs/fig/planqtn_logo.png" width="300"></img>
</p>

[![Unitary Foundation](https://img.shields.io/badge/Supported%20By-UNITARY%20FOUNDATION-brightgreen.svg?style=for-the-badge)](https://unitary.foundation)
[![Library Checks](https://github.com/planqtn/planqtn/workflows/planqtn%20Library%20Checks/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/lib_checks.yml)
[![UI & Docs Checks](https://github.com/planqtn/planqtn/workflows/UI%20&%20Docs%20Checks/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/ui_checks.yml)
[![License Check](https://github.com/planqtn/planqtn/workflows/License%20Check/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/license-check.yml)
[![API Server Checks](https://github.com/planqtn/planqtn/workflows/API%20Server%20Checks/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/api_server_checks.yml)
[![CLI Checks](https://github.com/planqtn/planqtn/workflows/CLI%20Checks/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/cli_checks.yml)
[![Jobs Checks](https://github.com/planqtn/planqtn/workflows/Job%20Execution%20Checks/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/jobs_checks.yml)
[![Cloud Integration Tests](https://github.com/planqtn/planqtn/workflows/Cloud%20Integration%20Tests/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/cloud_integration_tests.yml)
[![Local Integration Tests](https://github.com/planqtn/planqtn/workflows/Local%20Integration%20Tests/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/local_integration_tests.yml)
[![Package Publishing](https://github.com/planqtn/planqtn/workflows/Publish%20Packages/badge.svg)](https://github.com/planqtn/planqtn/actions/workflows/publish_packages.yml)

-   [planqtn.com](https://planqtn.com): PlanqTN Studio
-   [`planqtn` on Pypi](https://pypi.org/planqtn): the official PlanqTN Python
    library
-   [planqtn.com/docs](https://planqtn.com/docs): Documentation for both PlanqTN
    Studio and the Python library

# Welcome to PlanqTN!
PlanqTN is the [`planqtn`](https://pypyi.org/planqtn) python library and the
[PlanqTN Studio (https://planqtn.com)](https://planqtn.com), an interactive
studio to create, manipulate and analyze tensor network-based quantum error
correcting codes.

The name is a triple entendre on Planck, quantum and Tensor Networks (TN). It is
pronounced "plankton", and was inspired by the fact that each of the little
tensors look like a unique plankter. Also, while we love the quantum LEGO name,
we did not want to get into trademark problems.

The features are an implementation of the
[quantum LEGO framework by Charles Cao and Brad Lackey](https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.3.020332)
and the
[quantum LEGO expansion pack: enumerators from tensor networks by Cao, Gullans, Lackey and Wang](https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.5.030313),
but we also integrate with features that automate tensor network contraction
with [Cotengra](https://cotengra.readthedocs.io/) and take a unified approach to
quantum LEGO, ZX-calculus and graph states. Check out the detailed list of
[PlanqTN features](https://planqtn.com/docs/features)!

PlanqTN is open source under Apache 2.0 license and free for all, built with ❤️
by [@balopat](https://github.com/balopat), June Vanlerberghe and hopefully a lot
more future collaborators under the guiding council of Charles Cao, Brad Lackey,
and Kenneth R. Brown. If building tools like this sounds like fun to you, please
consider [contributing](https://planqtn.com/docs/contributing)!

We are supported by the [Unitary Foundation](https://unitary.foundation/).

# Contributing

PlanqTN is an open source project and we would love to see contributions from
you!

To get started with contributions, check out
[good first issues](https://github.com/planqtn/planqtn/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22),
and follow the
[DEVELOPMENT.md](https://github.com/planqtn/planqtn/blob/main/DEVELOPMENT.md)
for setup, developer workflows, and design concepts.

# License

Copyright 2025 Balint Pato

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.