Metadata-Version: 2.3
Name: tn4qa
Version: 0.0.1
Summary: A Python package to integrate tensor network methods with quantum algorithms.
License: MIT
Author: Angus Mingare
Author-email: angus.mingare.22@ucl.ac.uk
Requires-Python: >=3.11,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: black (>=24.10.0,<25.0.0)
Requires-Dist: cached-property (>=1.5.2,<2.0.0)
Requires-Dist: cotengra (>=0.6.2,<0.7.0)
Requires-Dist: cotengrust (>=0.1.4,<0.2.0)
Requires-Dist: coverage (>=7.6.9,<8.0.0)
Requires-Dist: isort (>=5.13.2,<6.0.0)
Requires-Dist: kahypar (>=1.3.5,<2.0.0) ; sys_platform == "darwin"
Requires-Dist: kahypar (>=1.3.5,<2.0.0) ; sys_platform == "linux"
Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
Requires-Dist: mypy (>=1.13.0,<2.0.0)
Requires-Dist: myst-parser (>=0.18.1,<0.19.0)
Requires-Dist: numpy (>=2.1,<3.0)
Requires-Dist: poetry (>=1.8.5,<2.0.0)
Requires-Dist: pre-commit (>=4.0.1,<5.0.0)
Requires-Dist: pydocstyle (>=6.3.0,<7.0.0)
Requires-Dist: pytest (>=7.2.2,<8.0.0)
Requires-Dist: qiskit (>=1.3.0,<2.0.0)
Requires-Dist: qiskit-aer (>=0.15.1,<0.16.0)
Requires-Dist: qiskit-ibm-runtime (>=0.34.0,<0.35.0)
Requires-Dist: ruff (>=0.8.2,<0.9.0)
Requires-Dist: scipy (>=1.15.0,<2.0.0)
Requires-Dist: sparse (>=0.15.4,<0.16.0)
Requires-Dist: sphinx (>=5.3.0,<6.0.0)
Requires-Dist: symmer (>=0.0.9,<0.0.10)
Description-Content-Type: text/markdown

# TN4QA

TN4QA (Tensor Networks for Quantum Algorithms) is a package designed to build workflows that use tensor network methods to assist quantum algorithms.

## Installation

Install the dependencies using
```
pip install poetry
poetry install
```

## Getting Started

From the top level of the repository you should be able to build the docs using the following

```
cd ./docs
make html
python3 -m http.server -d build/html 8080
```

so that the docs are accessible through http://localhost:8080. The documentation contains class information as well as tutorials on how to use TN4QA.

