qkit-gla 0.0.1rc0

A quantum measurement toolkit for superconducting qubits and resonators

Qkit-gla : a quantum measurement suite in python

Note: this is a adaptation measurement suite based on the KIT suite of the same name for Quantum Circuits Glasgow

Features:

• a collection of ipython notebooks for measurement and data analysis tasks.
• hdf5 based data storage of 1,2 and 3 dimensional data, including a viewer.
• classes for data fitting, e.g. of microwave resonator data. This includes also a robust circle fit algorithm.
• extended and maintained drivers for various low frequency and microwave electronics.

Platform:

The qkit framework has been tested under windows and with limits under macos x and linux. The gui requires h5py, qt and pyqtgraph, which work fine on these platforms. The core of the framework runs on Python 3.9+

Requirements:

This project uses python 3.9+. An up to date installation of python is expected to be present. The requirements are listed in the requirements.txt file.

They can be installed automatically using

pip install -r requirements.txt

Library	Usage
pyqt5	GUI
numpy, scipy, uncertainties	General Usage
pyqtgraph, matplotlib	Plotting
h5py	Data Stroage
jupyterlab	Interactive Notebooks
jupyterlab-templates	Notebook Templating
pyvisa, pyvisa-py	Communication with Devices
zhinst	Drivers for Zurich Instruments devices
zeromq	Messaging

Pre-requisites:

for Windows : Install some version of conda. Miniconda3 or Anaconda would do.

Installation:

It is recommended to install in a virtual-env or conda environment for compatibility with other dependencies. For venv see below. For a conda env :

#create a new py3.9 env
conda create -n qkit-env python=3.9

#activate the env
conda activate qkit-env

and install via pip and testPyPi

python -m pip install --upgrade pip

pip install -i https://test.pypi.org/simple/ qkit --extra-index-url https://pypi.org/simple

Alternative Install methods :

Clone this repository with

git clone https://github.com/qkitgroup/qkit.git

In this directory, create a virtual environment with the required dependencies. Should you not have virtualenv installed, see below.

 #(Windows) 
python -m venv .venv-test && .venv-test\Scripts\activate

# (Unix)
source .venv-test/bin/activate

Now install the dependencies using (in a python 3.9 env)

pip install -r requirements.txt

Installing venv

If you don't have support for virtual environments, enable it by running

pip install virtualenv

Usage

Usually run within a Jupyter Notebook

1. Create a cell

import qkit

qkit.cfg['load_visa'] = True
qkit.cfg['run_id'] = 'run001'
qkit.cfg['datadir'] = path/to/data/folder
qkit.cfg['debug']='ERROR'

qkit.start()