Q-Lab

A framework designed for Circuit QED experiments, providing an all-in-one solution for the researchers in the relevant field.

It works in the Jupyter Notebook.

Structure

1. 顶层为 qulab 项目和 setup 信息。
2. qulab 包含：设备驱动配置模块 drivers 和 device、用户工具模块 tools、软件管理模块。
3. 软件的代码、数据存储管理、仪器配置、用户信息等通过 MongoDB 实现。

Installation

1. 运行环境安装

   • Python

     从官网下载安装。

   • Jupyter System

     命令窗口中 pip 指令 python -m pip install jupyter。 如果用户位置为中国大陆，可以采用镜像源，在指令中加入 python -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple jupyter。

   • Git

     若系统未安装 git，则可以按照说明，选择对应系统进行安装。

2. MongoDB (Community Edition)

   安装和配置过程请参考教程。

3. Q-Lab

$ cd /*/*/*（其中‘/*/*/*’为准备安装Quantum_Lab的路径）
$ git clone https://github.com/BaksiLi/Q-Lab.git
$ cd Q-Lab
$ pip install .

4. SSL Certificate

   • 制作 ssl 证书，用于 InstrumentServer 加密，参考'create_config_yaml.md'文件。

   • 创建配置文件 config.yaml，若使用 Windows 系统，将其置于%ProgramData%\QuLab\路径下。参考 create_config_yaml.md 文件。

5. Run MongoDB (everytime)

6. $ cd /usr/local/mongodb/bin（若不是该路径，则改为对应mongodb安装的路径）

7. $ sudo ./mongod 此操作为开启MongoDB的服务端口，若未开启该服务端口，则Quantum_Lab程序无法进行代码和数据管理，从而无法使用。 若要通过命令窗口查看MongoDB数据库，则进入到/usr/local/mongodb/bin，然后执行‘mongo’指令。

8. 也可以将路劲添加到系统环境变量path里，然后在任意路劲下直接运行 $ mongod即可。

Examples

_{This section is slightly out-dated.}

创建初始用户

from qulab.admin import register
register()

登陆系统

import qulab
qulab.login()

创建并运行简单 App

定义 App

import numpy as np
import asyncio
import qulab

class TestApp(qulab.Application):
    '''一个简单的 App'''
    async def work(self):
        async for x in self.sweep['x']:
            yield x, np.random.randn()

    async def set_x(self, x):
        await asyncio.sleep(0.5)
        # print('x =', x)

    @staticmethod
    def plot(fig, data):
        x, y = data
        ax = fig.add_subplot(111)
        ax.plot(x, y)
        ax.set_xlabel('x (a.u.)')
        ax.set_ylabel('y (a.u.)')

将其提交到数据库

TestApp.save(package='test')

一旦将App提交到数据库，以后就不必重复将代码复制过来运行了。直接配置并运行即可。

import qulab
import numpy as np

app = qulab.make_app('TestApp', package='test').sweep([
    ('x', np.linspace(0, 1, 11))
])
qulab.make_figure_for_app(app)
app.run()

创建复杂一点的 App

import numpy as np
import asyncio
import qulab

class ComplexApp(qulab.Application):
    '''一个复杂点的 App'''
    async def work(self):
        async for y in self.sweep['y']:
            # 一定要注意设置 parent
            app = qulab.make_app('test.TestApp', parent=self)
            x, z = await app.done()
            yield x, y, z

    async def set_y(self, y):
        await asyncio.sleep(0.5)
        # print('x =', x)

    def pre_save(self, x, y, z):
        if self.data.rows > 1:
            x = x[0]
        return x, y, z

    @staticmethod
    def plot(fig, data):
        x, y, z = data
        ax = fig.add_subplot(111)
        if isinstance(y, np.ndarray):
            ax.imshow(z, extent=(min(x), max(x), min(y), max(y)),
                     aspect='auto', origin='lower', interpolation='nearest')
        else:
            ax.plot(x, z)
        ax.set_xlabel('x (a.u.)')
        ax.set_ylabel('y (a.u.)')

保存

ComplexApp.save(package='test')

运行

import qulab
import numpy as np

app = qulab.make_app('ComplexApp', package='test').sweep([
    ('x', np.linspace(0, 1, 11)),
    ('y', np.linspace(3,5,11))
])
qulab.make_figure_for_app(app)
qulab.make_figures_for_App('TestApp')
app.run()

涉及到仪器操作

1. 安装 drivers

import os

path = 'path/to/drivers'

for f in os.listdir(path):
    qulab.admin.uploadDriver(os.path.join(path, f))

2. 查看已有的 drivers

qulab.listDrivers()

3. 添加仪器设置

# 第一台网分
qulab.admin.setInstrument('PNA-I', 'localhost', 'TCPIP::10.122.7.250', 'NetworkAnalyzer')
# 第二台网分
qulab.admin.setInstrument('PNA-II', 'localhost', 'TCPIP::10.122.7.251', 'NetworkAnalyzer')

4. 查看已存在的仪器

qulab.listInstruments()

5. 连接仪器

pna=qulab.open_resource('PNA-I')

6. 定义 App

import numpy as np
import skrf as rf
from qulab import Application


class S21(Application):
    '''从网分上读取 S21

    require:
        rc : PNA
        settings: repeat(optional)

    return: Frequency, Re(S21), Im(S21)
    '''
    async def work(self):
        if self.params.get('power', None) is None:
            self.params['power'] = [self.rc['PNA'].getValue('Power'), 'dBm']
        x = self.rc['PNA'].get_Frequency()
        for i in range(self.settings.get('repeat', 1)):
            self.processToChange(100.0 / self.settings.get('repeat', 1))
            y = np.array(self.rc['PNA'].get_S())
            yield x, np.real(y), np.imag(y)
            self.increaseProcess()

    def pre_save(self, x, re, im):
        if self.data.rows > 1:
            x = x[0]
            re = np.mean(re, axis=0)
            im = np.mean(im, axis=0)
        return x, re, im

    @staticmethod
    def plot(fig, data):
        x, re, im = data
        s = re + 1j * im
        ax = fig.add_subplot(111)
        ax.plot(x / 1e9, rf.mag_2_db(np.abs(s)))
        ax.set_xlabel('Frequency / GHz')
        ax.set_ylabel('S21 / dB')

7. 保存

S21.save(package='PNA')

8. 运行

import qulab

app = lab.make_app('PNA.S21').with_rc({
    'PNA': 'PNA-II'     # PNA-II 必须是已经添加到数据库里的设备名
}).with_settings({
    'repeat': 10
}).with_params(
    power = [-27, 'dBm'],
    att = [-30, 'dB']
).with_tags('5 bits sample', 'Cavity 1')

qulab.make_figure_for_app(app)

app.run()

查询

1. 查看已有的 App

qulab.listApps()

2. 查询数据

results = qulab.query('PAN.S21')
results.display()

3. 获取原始数据

res = qulab.query(app='TestApp')
x,y = res[0].data

import matplotlib.pyplot as plt
plt.plot(x, y)
plt.show()

Acknowledgement

The first commit of this repo is licensed (inherited) under MIT License.

However, the following commits/releases are licensed under Apache Version 2.0, please read LICENSE for the details.