Metadata-Version: 2.4
Name: pysuqu
Version: 2.0.2
Summary: Python toolkit for superconducting qubit simulation.
Home-page: https://github.com/znb888/pysuqu
Author: Naibin Zhou
Author-email: zhnb@mail.ustc.edu.cn
License: GNU Affero General Public License v3 or later (AGPLv3+)
Project-URL: Source, https://github.com/znb888/pysuqu
Project-URL: Documentation, https://github.com/znb888/pysuqu/tree/main/docs
Project-URL: Issues, https://github.com/znb888/pysuqu/issues
Keywords: superconducting qubit,quantum simulation,transmon,decoherence
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.4.0
Requires-Dist: numpy>=1.20.0
Requires-Dist: plotly>=5.0.0
Requires-Dist: qutip>=4.7.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: tqdm>=4.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<div align="center">
  <img
    src="https://raw.githubusercontent.com/znb888/pysuqu/main/docs/assets/pysuqu-logo.svg"
    alt="pysuqu logo"
    width="760"
  />
</div>

# pysuqu

[![PyPI version](https://img.shields.io/pypi/v/pysuqu?style=flat-square&label=PyPI&color=0f766e&logo=pypi&logoColor=white)](https://pypi.org/project/pysuqu/)
[![Python versions](https://img.shields.io/pypi/pyversions/pysuqu?style=flat-square&label=Python&color=2563eb&logo=python&logoColor=white)](https://pypi.org/project/pysuqu/)
[![License](https://img.shields.io/badge/License-AGPLv3%2B-f59e0b?style=flat-square&logo=gnu&logoColor=white)](https://github.com/znb888/pysuqu/blob/main/LICENSE)

Python toolkit for superconducting qubit simulation.

`pysuqu` provides qubit modeling, multi-qubit and coupler workflows, and
decoherence/noise analysis in one package.

[English](#english) | [简体中文](#zh-cn)

<a id="english"></a>

## English

`pysuqu` is a public Python package for superconducting qubit simulation. This
repository contains the library, documentation, tests, and demo notebooks with
synthetic or public-safe data.

### Install

For most users, install from PyPI:

```bash
pip install pysuqu
```

`pysuqu` supports Python `3.8+`.

If you want the latest repository version for development:

```bash
git clone https://github.com/znb888/pysuqu.git
cd pysuqu
pip install -r requirements.txt
pip install -e .
```

### What It Covers

- `pysuqu.qubit` for single-qubit and multi-qubit superconducting circuit
  modeling
- `pysuqu.decoherence` for decoherence and noise-analysis workflows
- `demo/` for end-to-end notebook examples

### Quick Start

This example builds a simple transmon-like qubit model and prints the first
three energy levels:

```python
from pysuqu.qubit import AbstractQubit

qubit = AbstractQubit(
    frequency=5e9,
    anharmonicity=-250e6,
    frequency_max=6e9,
    qubit_type="Transmon",
    energy_trunc_level=12,
    is_print=False,
)

print(qubit.get_energylevel()[:3])
```

For decoherence and coupler workflows, the notebook examples in `demo/` are the
best next stop.

### Where To Start

- [Getting started guide](https://github.com/znb888/pysuqu/blob/main/docs/guides/getting-started.md)
- [Documentation index](https://github.com/znb888/pysuqu/blob/main/docs/README.md)
- [Demo notebooks](https://github.com/znb888/pysuqu/blob/main/demo/README.md)
- [Module map](https://github.com/znb888/pysuqu/blob/main/docs/architecture/module-map.md)

### Public API Notes

- For normal usage, start from `pysuqu.qubit` and `pysuqu.decoherence`.
- `pysuqu.qubit.experimental` contains exploratory placeholders and is not part
  of the usual workflow.
- Demo notebooks in this public repository use synthetic or public-safe data.

<a id="zh-cn"></a>

## 简体中文

`pysuqu` 是一个面向超导量子比特仿真的 Python 包。这个公开仓库包含库代码、
文档、测试，以及使用合成数据或公开安全数据整理出的 demo notebook。

### 安装

普通用户直接从 PyPI 安装：

```bash
pip install pysuqu
```

`pysuqu` 支持 Python `3.8+`。

如果你想基于仓库开发，安装方式如下：

```bash
git clone https://github.com/znb888/pysuqu.git
cd pysuqu
pip install -r requirements.txt
pip install -e .
```

### 主要内容

- `pysuqu.qubit`：单比特、多比特和耦合器相关的建模能力
- `pysuqu.decoherence`：退相干与噪声分析工作流
- `demo/`：端到端 notebook 示例

### 快速开始

下面这个例子会构建一个简化的 transmon 模型，并输出前三个能级：

```python
from pysuqu.qubit import AbstractQubit

qubit = AbstractQubit(
    frequency=5e9,
    anharmonicity=-250e6,
    frequency_max=6e9,
    qubit_type="Transmon",
    energy_trunc_level=12,
    is_print=False,
)

print(qubit.get_energylevel()[:3])
```

如果你要看退相干分析或 coupler 工作流，最直接的入口是 `demo/` 里的 notebook。

### 从哪里开始

- [入门指南](https://github.com/znb888/pysuqu/blob/main/docs/guides/getting-started.md)
- [文档索引](https://github.com/znb888/pysuqu/blob/main/docs/README.md)
- [Demo 说明](https://github.com/znb888/pysuqu/blob/main/demo/README.md)
- [模块地图](https://github.com/znb888/pysuqu/blob/main/docs/architecture/module-map.md)

### 公共 API 说明

- 正常使用时，优先从 `pysuqu.qubit` 和 `pysuqu.decoherence` 开始。
- `pysuqu.qubit.experimental` 里是探索性占位入口，不属于常规工作流。
- 本公开仓库中的 demo notebook 只使用合成数据或公开安全数据。

## License / 许可证

`pysuqu` is licensed under the
[GNU Affero General Public License v3.0 or later](https://github.com/znb888/pysuqu/blob/main/LICENSE).

欢迎通过 issue 和 pull request 提出改进。
