Metadata-Version: 2.4
Name: quarkcircuit
Version: 0.5.13
Summary: Construction, visualization, and transpilation of quantum circuits
Author-email: Xiaoxiao Xiao <xiaoxx@baqis.ac.cn>
License: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: networkx
Requires-Dist: requests
Provides-Extra: display
Requires-Dist: ipython; extra == "display"

# QuarkCircuit

[![PyPI - Python Version](https://img.shields.io/badge/python-3.12%20|%203.13%20|%203.14-pink.svg)](https://pypi.org/project/quarkcircuit/)
[![Downloads](https://static.pepy.tech/badge/quarkcircuit)](https://pepy.tech/project/quarkcircuit)
[![API](https://img.shields.io/badge/API-quarkcircuit-green.svg)](https://quarkstudio.readthedocs.io/en/latest/modules/quark/circuit/)

QuarkCircuit is a quantum circuit construction and transpilation toolkit, deployed on the [Quafu quantum computing cloud platform](https://quafu-sqc.baqis.ac.cn/) for real superconducting chip experiments.

## Features

- **Construction** — Build quantum circuits intuitively with standard gate sets
- **Visualization** — Clean text-based circuit diagrams with Unicode characters
- **Transpilation** — Layout mapping, Sabre routing, basis gate translation

## Installation

```bash
pip install quarkcircuit
```

Requires Python 3.12, 3.13, or 3.14. Supports Linux, macOS, and Windows.

## Quick start

```python
from quark.circuit import QuantumCircuit, generate_ghz_state

# Create a GHZ state circuit
qc = generate_ghz_state(4)
qc.measure_all()

# Draw the circuit
qc.draw()
```

## Examples

See [quarkcircuit examples](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/).

## License

[MIT](LICENSE)
