pysuqu

Python toolkit for superconducting qubit simulation.

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

English | 简体中文

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:

pip install pysuqu

pysuqu supports Python 3.8+.

If you want the latest repository version for development:

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
• transmission-chain simulation for AWG/qubit reference planes, Touchstone S-parameters, digital precorrection, and multi-line MIMO propagation
• 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:

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
• Documentation index
• Demo notebooks
• Transmission-chain guide
• Module map

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.

简体中文

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

安装

普通用户直接从 PyPI 安装：

pip install pysuqu

pysuqu 支持 Python 3.8+。

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

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

主要内容

• pysuqu.qubit：单比特、多比特和耦合器相关的建模能力
• pysuqu.decoherence：退相干与噪声分析工作流
• 传输链仿真：AWG/量子比特参考面、Touchstone S 参数、数字预校正与多线 MIMO 传播
• demo/：端到端 notebook 示例

快速开始

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

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。

从哪里开始

• 入门指南
• 文档索引
• Demo 说明
• 传输链指南
• 模块地图

公共 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.

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