- 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.
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 should run with python 2.7.x/3.4+
This project uses python. 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 |
If you use an existing installation of qkit, where the Jupyter Notebooks are not located in ./notebooks
, then you will need to change one line in jupyter_lab_config.py
:
# Set Notebook directory
notebook_dir = 'notebooks' # Change this line
On Windows, this might be set to:
# Set Notebook directory
notebook_dir = r'C:\notebooks' # Change this line
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.
virtualenv .venv
Depending on your operating system you need to run (Linux)
source .\.venv/Scripts/activate
or (Windows):
.\.venv\Scripts\Activate.ps1
Now install the dependencies using
pip install -r requirements.txt
If you don't have support for virtual environments, enable it by running
pip install virtualenv
Add the qkit/qkit directory to your systems PYTHONPATH variable.
If you use the included scripts to run JupyterLab, then this step is not required.
Depending on your operating system, run launch.ps1
(Windows) or launch.sh
(Linux)