欢迎使用 pyEPR 🍻!      (参见 arXiv:2010.00620)

约瑟夫森量子电路设计和量化的自动化 Python 模块

<br>

文档

点击此处阅读文档。 <br>

科研工作:

• Minev, Z. K., Leghtas, Z., Mudhada, S. O., Reinhold, P., Diringer, A., & Devoret, M. H. (2018). pyEPR: 量子器件设计的能量参与率(EPR)开源框架。
• Minev, Z. K., Leghtas, Z., Mundhada, S. O., Christakis, L., Pop, I. M., & Devoret, M. H. (2020). 约瑟夫森电路的能量参与量化。ArXiv. 网址：http://arxiv.org/abs/2010.00620 (2020)
• Z.K. Minev, 博士论文, 耶鲁大学 (2018), 第4章。(arXiv:1902.10355) (2018)

pyEPR 工作组会议 -- 规划 pyEPR 的未来

• 请在此报名: https://github.com/zlatko-minev/pyEPR/issues/45 或 直接在此报名 ❗️🍻

• 查看 pyEPR wiki 获取第一次会议的笔记。
• 我们将在1-2个月内安排后续会议。

<br>

谁在使用 pyEPR?

• 耶鲁大学, Michel Devoret 实验室 QLab, 康涅狄格州, 美国
• 耶鲁大学, Rob Schoelkopf 实验室 RSL, 康涅狄格州, 美国
• IBM Quantum 和 IBM 的 Qiskit Metal
• QUANTIC (量子信息电路), 巴黎国家信息与自动化研究所, 法国高等师范学院, 巴黎高等矿业学院, 巴黎第六大学, 法国国家科学研究中心。Zaki Leghtas 及其团队。法国
• Quantum Circuit Group Benjamin Huard, 里昂高等师范学校, 法国
• Emanuel Flurin, 法国原子能委员会萨克雷研究中心, 法国
• Ioan Pop 小组, 卡尔斯鲁厄理工学院物理研究所, 德国
• 加州大学伯克利分校, 量子纳米电子实验室, Irfan Siddiqi, 加利福尼亚州, 美国
• Quantum Circuits, Inc., 康涅狄格州, 美国
• Seeqc (Hypres 的分拆公司) 数字量子计算, 美国
• Serge [Rosenblum 实验室] 量子电路小组 (https://www.weizmann.ac.il/condmat/rosenblum/) 魏茨曼研究所, 以色列
• 牛津大学 - LeekLab - Peter Leek 实验室, 英国
• Britton Plourde 实验室, 雪城大学, 美国
• Javad Shabani 实验室 量子材料与器件, 纽约大学, 纽约, 美国
• 芝加哥大学 Dave Schuster 实验室, 美国
• SQC 实验室 - Shay Hacohen Gourgy, 以色列
• 劳伦斯伯克利国家实验室
• 科罗拉多矿业学院, 美国
• 雪城大学, 美国
• 上海交通大学 IPQC, 上海, 中国
• 巴巴原子研究中心, 印度
• 英国量子计算
• Alice&Bob, 法国
• 量子技术中心 / Qcrew
• 苏黎世联邦理工学院量子器件实验室; Andreas Wallraff
• Bleximo
• ... 还有更多! (请发送电子邮件至 zlatko.minev@aya.yale.edu 进行更新。)

<br>

内容:

• 从这里开始: 使用 pyEPR
• 视频教程
• pyEPR 的安装与设置
• HFSS 项目设置 pyEPR
• pyEPR 故障排除
• 作者与贡献者

从这里开始: 使用 pyEPR

1. 在GitHub上 :fork_and_knife: 复刻pyEPR顶级仓库。（如何复刻GitHub仓库？）。通过给pyEPR点 :star: 星标来表示支持。

2. 在本地 :point_down: 克隆你复刻的仓库。（如何克隆GitHub仓库？）。按照pyEPR安装和Python设置来设置pyEPRPython代码。

3. 使用Jupyter笔记本教程来学习如何使用。

4. 保持更新享受使用，并确保添加主远程分支 git remote add MASTER_MINEV git://github.com/zlatko-minev/pyEPR.git (需要帮助?)。

5. 引用pyEPR arXiv:2010.00620 / arXiv:1902.10355 并尽情使用！:birthday:

启动示例

Jupyter笔记本教程

以下代码展示了如何使用pyEPR仅用几行代码就完成对简单的两比特、一腔设备的完整分析。在HFSS文件中，运行脚本之前，首先指定非线性结点矩形和变量（参见HFSS中的pyEPR项目设置部分）。本征分析和哈密顿量计算中的所有操作都是完全自动化的。结果会被保存、打印并简洁地绘制出来。

# 载入pyEPR。参见教程笔记本！
import pyEPR as epr

# 1. 连接到你的Ansys，并加载你的设计
pinfo = epr.ProjectInfo(project_path = r'C:\sim_folder',
                        project_name = r'cavity_with_two_qubits',
                        design_name  = r'Alice_Bob')


# 2a. 非线性（约瑟夫森）结
pinfo.junctions['jAlice'] = {'Lj_variable':'Lj_alice', 'rect':'rect_alice', 'line': 'line_alice', 'Cj_variable':'Cj_alice'}
pinfo.junctions['jBob']   = {'Lj_variable':'Lj_bob',   'rect':'rect_bob',   'line': 'line_bob', 'Cj_variable':'Cj_bob'}
pinfo.validate_junction_info() # 检查是否提供了有效的变量和对象名称。

# 2b. 耗散元件：指定
pinfo.dissipative['dielectrics_bulk']    = ['si_substrate', 'dielectric_object2'] # 提供hfss对象的名称
pinfo.dissipative['dielectric_surfaces'] = ['interface1', 'interface2']
# 或者，这些可以在ProjectInfo中指定
# pinfo = epr.ProjectInfo(..., dielectrics_bulk = ['si_substrate', 'dielectric_object2'])

# 3. 对本征模式解进行微波分析
eprd = epr.DistributedAnalysis(pinfo)
if 1: # 自动报告
  eprd.quick_plot_frequencies(swp_var) # 在分析前绘制求解的频率
  eprd.hfss_report_full_convergence() # 报告收敛性
eprd.do_EPR_analysis()

# 4a. 基于EPR的微波解进行哈密顿量谱后分析
epra = epr.QuantumAnalysis(eprd.data_filename)
epra.analyze_all_variations(cos_trunc = 8, fock_trunc = 7)

# 4b. 报告求解结果
swp_variable = 'Lj_alice' # 假设我们对电感Lj_alice进行了优化分析扫描
epra.plot_hamiltonian_results(swp_variable=swp_variable)
epra.report_results(swp_variable=swp_variable, numeric=True)
epra.quick_plot_mode(0,0,1,numeric=True, swp_variable=swp_variable)

pyEPR视频教程 <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/534c7a11-dccf-438c-ad2c-94eadfa2446a.svg" height=30>

<div style="overflow:auto;"> <table style=""> <tr> <th> <a href="https://www.youtube.com/watch?v=fSRYvD-ITnQ&list=PLnak_fVcHp17tydgFosNtetDNjKbEaXtv&index=1"> 教程1 - 概述 <br> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/a78635fa-8302-4178-a7f3-4c40e8808d8a.jpg" alt="pyEPR教程1 - 概述" width=250> </a> </th> <th> <a href="https://www.youtube.com/watch?v=ZTi1pb6wSbE&list=PLnak_fVcHp17tydgFosNtetDNjKbEaXtv&index=2"> 教程2 - Conda和Git的设置 <br> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/fce43a9b-8bac-42e0-b229-5b2515be0e7a.jpg" alt="pyEPR教程2 - Conda和Git的设置" width=250> </a> </th> <th> <a href="https://www.youtube.com/watch?v=L79nlXY2w4s&list=PLnak_fVcHp17tydgFosNtetDNjKbEaXtv&index=3"> 教程3 - 包和配置的设置 <br> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/60460c39-009d-4973-b376-457f85ca5f7e.jpg" alt="pyEPR教程3 - 包和配置的设置" width=250> </a> </th> </tr> </table> </div>

Jupyter笔记本教程

pyEPR的安装和设置

---

直接从源代码使用pyEPR，并从主Git仓库拉取更新，因为我们经常更新它。以下步骤解释了如何设置Python 3、复刻pyEPR仓库并使用它。 请使用git保持pyEPR的更新。我们喜欢使用git图形界面管理器来简化操作，比如SourceTree或GitHub Desktop。 快速设置 我们推荐以下章节的方法,这将是最新的,但如果想快速使用,可以使用 conda forge 频道 进行安装

conda install -c conda-forge pyepr-quantum

或者使用 PyPi 频道

pip install pyEPR-quantum

推荐步骤 <br />

1. 安装 Python 3.x,我们推荐 Anaconda 发行版。<br> 代码目前在 Python 3.6/7 下开发。它最初是在 2.7 下开发的,应该仍然兼容。<br> 安装后,请确保配置系统 PATH 变量。在 Windows 上,在任务栏搜索或控制面板中,搜索"编辑账户的环境变量"。在系统变量部分,找到 PATH 环境变量并选择它。点击编辑。将 C:\Anaconda3;C:\Anaconda3\Scripts;C:\Anaconda3\Library\bin; 放在路径的开头。如果你之前安装过 Python,这一步非常重要,尤其是为了编译 qutip 模块。你可以在命令提示符(终端)中使用以下命令验证你的路径: sh $ echo %PATH%

2. 安装所需的包,包括 pint、qutip 和 addict。在终端窗口中:

conda install -c conda-forge pint
conda install -c conda-forge qutip
pip install addict

3. 在 GitHub 上用你的 GitHub 账户 fork 这个 pyEPR 仓库。你可以将 fork 克隆到你的电脑上,并使用 SourceTree git GUI 管理器进行管理。
4. 将 pyEPR 仓库文件夹添加到你的 Python 搜索路径。确保设置了指向主仓库的 git remote,git remote add MASTER_MINEV git://github.com/zlatko-minev/pyEPR.git! (需要帮助?)
5. 编辑 pyEPR 模块的 _config_user.py 文件,设置你的数据保存目录和其他感兴趣的参数。(要保持你的更改为本地,在 pyEPR/pyEPR 文件夹中使用 shell 命令 git update-index --skip-worktree _config_user.py)
6. 尽情使用并引用 pyEPR! :+1:

用于开发模式的"可编辑"安装

虽然不是必需的,但在开发过程中通常会以"可编辑"或"开发"模式在本地安装你的项目。这允许你的项目既可以安装,又可以以项目形式进行编辑。

假设你在项目的根目录下,运行以下命令(参见此处):

   python -m pip install -e .

尽管有些晦涩,-e 是 --editable 的缩写,而 . 指的是当前工作目录,所以合在一起,它意味着以可编辑模式安装当前目录(即你的项目)。这也会安装任何用"install_requires"声明的依赖项和任何用"console_scripts"声明的脚本。依赖项将以常规的、不可编辑的模式安装。引用自python

Mac/Linux 注意事项

按照上述相同的说明操作。你不应该需要安装 mingw 或修改 distutils.cfg,因为你的发行版应该已经将 gcc 作为默认编译器。

旧版用户

警告: pyEPR 组织在 v0.8-dev (从 2020 年开始;当前分支:master [即将稳定])中进行了重大改进。如果你使用了之前的版本,你会发现所有关键类都已重命名。请参阅教程和文档。同时,如果你还不能切换,请回退使用稳定版 v0.7。

pyEPR 的 HFSS 项目设置

---

特征模式设计 --- 如何设置结点

你可以在这里找到建议的工作流程和一些设置技巧。

1. 定义电路几何和电磁边界条件(BC)。
   1. 结点矩形和 BC:为每个约瑟夫森结点创建一个矩形,并给它一个好名字;例如,为名为 Alice 的量子比特创建 jAlice。我们推荐使用 50 x 100 μm 的矩形进行简单模拟,尽管小几个数量级的矩形也可以工作。注意这个结点的长度,你需要将其提供给 pyEPR。在这个矩形表面上分配一个 Lumped RLC BC,其电感值由一个局部变量给出,例如 Lj1。这个变量的名称也将提供给 pyEPR。
   2. 在每个结点矩形上绘制一条模型 polyline,以定义结点电流流动方向的感。这条线应该跨越整个结点矩形的长度。使用结点矩形上的对象坐标系定义它(这样当几何形状改变时它们会一起移动)。这条线的名称将提供给 pyEPR 模块。
2. 网格划分。
   1. 对薄膜金属 BC 进行轻度网格划分。对结点矩形进行轻度网格划分。
3. 仿真设置
   1. 我们推荐使用 mixed order 解。

<p align="center"> <img width="50%" height="50%" src="https://yellow-cdn.veclightyear.com/0a4dffa0/776d5047-e870-47fd-9d26-530b63b24f03.gif"> </p>

pyEPR 故障排除

---

首次运行:pint 错误:system='mks' 未知。

请更新到 0.7.2 以上版本的 pint。你可以使用

pip install pint --upgrade

在 do_EPR_analysis() 期间没有属性 StringIO

AttributeError: module 'pandas.compat' has no attribute 'StringIO'

Caleb 指出了这一点,请参见这里和解决方案。你需要更改 pandas 版本。[pyEPR 待升级]

这个问题在这次提交中得到了解决。尝试将你的 pyEPR 版本更新到当前的 master。

导入 qutip 时出现错误 AttributeError: module 'numpy' has no attribute '__config__'

你可能需要更新你的 numpy 安装。对我来说,以下 bash 序列有效:

conda update qutip
conda update numpy

Qutip安装

你也可以选择安装可选的qutip包来进行一些高级的哈密顿量数值分析。 我们使用Qutip来处理量子对象。按照他们网站上的说明进行操作。截至2017年8月，qutip已成为conda的一部分，你可以使用

conda install qutip

如果这不起作用，请尝试从conda forge安装

conda install -c conda-forge qutip

Qutip安装 -- 替代方案，手动安装

如果你想手动安装，请按照以下步骤操作。有些步骤可能会比较棘手。 首先，你需要安装一个C编译器，因为qutip使用Cython。如果你没有安装VS9、gcc或mingw，以下方法可行：

pip install -i https://pypi.anaconda.org/carlkl/simple mingwpy

让anaconda知道使用这个编译器，通过创建文件C:\Anaconda2\Lib\distutils\distutils.cfg，内容如下

[build]
compiler = mingw32
[build_ext]
compiler = mingw32

接下来，让我们安装qutip。你可以选择使用conda install或pip install，或者直接从git拉取，如这里所示：

conda install git
pip install git+https://github.com/qutip/qutip.git

打开HFSS时出现COM错误

仔细检查项目和设计文件名。确保文件路径中没有撇号或其他不良字符，例如C:\Minev's PC\my:Project。检查HFSS是否弹出了错误对话框，如"文件被锁定"。手动打开HFSS和文件。

计算表达式时出现COM错误

可能是HFSS弹出了错误对话框，或者冻结了，或者你输错了某些名称。

HFSS拒绝关闭

如果你的脚本不正常终止，可能会发生这种情况。pyHFSS尝试捕获终止事件并处理它们。但是，如果你在完成后调用hfss.release()，你的安全应该得到保证。如果你想关闭HFSS，请使用任务管理器（MAC上的活动监视器）。

参数扫描错误

在HFSS中运行参数扫描时，确保在运行pyEPR之前实际上为每个变体保存了场。这可以通过右键单击你的ParametricSetup -> 属性 -> 选项 -> "保存场和网格"来完成。

Spyder弹出执行tput.exe的命令窗口cmd

这个问题是由pandas 0.20.1引起的，更新到0.20.3或更高版本可以解决这个问题。 <br>

ValueError: cannot set WRITEABLE flag to True of this array

当尝试用numpy 1.16版本读取hdf文件时会出现这个错误，参见这里的git问题。一个解决方案是将numpy降级到1.15.4或升级到更新版本的hdf和numpy。

作者和贡献者

• 作者： Zlatko Minev & Zaki Leghtas，以及许多朋友和同事的贡献。(arXiv:2010.00620)
• 2015年至今。
• 贡献者：Phil Rheinhold、Lysander Christakis、Devin Cody等。 pyHFSS.py和pyNumericalDiagonalization.py的原始版本由Phil Rheinhold贡献，优秀的原始仓库。
• 使用条款：自由使用并请善意引用论文（arXiv链接将在此处发布）和/或本软件包。
• 我如何贡献？联系Z. Minev或Z. Leghtas。

如何引用pyEPR？

使用这个bibtex来引用pyEPR，对于方法请使用能量参与率论文arXiv:2010.00620。