Welcome to the QTT framework. This README will shortly introduce the framework, and it will guide you through the structure, installation process and how to contribute. We look forward to working with you!
Quantum Technology Toolbox (QTT) is a Python-based framework developed initially by QuTech for the tuning and calibration of quantum dots and spin qubits. QuTech is an advanced research center based in Delft, the Netherlands, for quantum computing and quantum internet, a collaboration founded by the University of Technology Delft (TU Delft) and the Netherlands Organisation for Applied Scientific Research (TNO).
For usage of QTT see the detailed documentation on readthedocs.io.
QTT is the framework on which you can base your measurement and analysis scripts. QTT is based on Qcodes (basic framework such as instrument drivers, DataSet) and the SciPy ecosystem.
QTT is compatible with Python 3.5+. QTT can be installed as a pip package:
$ pip install qtt
For development we advice to install from source. First retrieve the source code using git, and then install from the qtt source directory using the command:
$ python setup.py develop
For the Vandersypen research group there are more detailed instructions, read the file INSTALL.md in the spin-projects repository.
If you registered qtt with Python via setup.py develop
, all you need to do to get the latest code is open a terminal window pointing to anywhere inside the repository and run git pull
See the documentation and the example notebooks in the docs/notebooks directory.
For a general introduction also see
-
If you use Spyder then use the following settings:
- Use a
IPython
console and inTools->Preferences->IPython console->Graphics
set the IPython backend graphics option toQt5
. This ensures correctly displaying theParameterViewer
andDataBrowser
- In
Tools->Preferences->Console->Advanced settings
uncheck the boxEnable UMR
- Use a
See Contributing for information about bug/issue reports, contributing code, style, and testing
Tests for the qtt packages are contained in the subdirectory tests
and as test
functions (test_*
) in the code. To run the tests you can run the following command:
$ pytest
See License