qcodes 0.1.2

Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium

QCoDeS

QCoDeS is a Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium. While it has been developed to serve the needs of nanoelectronic device experiments, it is not inherently limited to such experiments, and can be used anywhere a system with many degrees of freedom is controllable by computer. To learn more about QCoDeS, browse our homepage .

To get a feeling of qcodes browse the Jupyter notebooks in docs/examples .

QCoDeS is compatible with Python 3.5+. It is primarily intended for use from Jupyter notebooks, but can be used from traditional terminal-based shells and in stand-alone scripts as well. Although some feature at the moment are b0rken outside the notebook.

Status

QCoDeS is still in development, more documentation and features will be coming! The team behind this project just expanded. There are still rough edges, and gray areas but QCoDeS has been running without major issue in two long running experiments.

The most important features in the roadmap are:

• a robust architecture that uses the full potential of your harwdare

• a more flexible and faster data storage solution

Install

This is mostly for tech-y scientist, in general refer to here for installation.

PyPi

pip install qcodes

And see if you miss any dependencies.

Plotting Requirements

Because these can sometimes be tricky to install (and not everyone will want all of them), the plotting packages are not set as required dependencies, so setup.py will not automatically install them. You can install them with pip:

• For qcodes.MatPlot: matplotlib version 1.5 or higher

• For qcodes.QtPlot: pyqtgraph version 0.9.10 or higher

Developer-pyenv

Core developers use virtualenv and pyenv to make sure all the system are the same, this rules out issues and the usual “it works on my machine”. Install pyenv on your OS see this .

$QCODES_INSTALL_DIR is the folder where you want to have the source code.

git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR
cd $QCODES_INSTALL_DIR
pyenv install 3.5.2
pyenv virtualenv 3.5.2 qcodes-dev
pip install -r develop_requirements.txt
pip install -e .
python qcodes/test.py -f

If the tests pass you are ready to hack! This is the reference setup one needs to have to contribute, otherwise too many non-reproducible environments will show up.

If all of this sounds too complicated, use anaconda!

Anaconda

One can also use anaconda:

• First clone the repo

  `` git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR ``

• Open the ‘navigator’ app that was installed with anaconda.

• On the left side click on “Environments”.

• Then on the “import” icon, on the bottom.

• Pick a name, and click on the folder icon next to file to import from.

• Make sure you select “Pip requirement files” from the “Files of type” dialog then navigate to the qcodes folder (QCODES_INSTALL_DIR) and select basic_requirements.txt.

• Finally click import, and wait until done.

• The enviroment is now created, click on the green arrow to open a terminal inside it.

• Navigate again with the terminal (or drag and drop the the folder on OsX)

• Most likely you will want to plot stuff, so type:

conda install matplotlib

and after if you want qtplot

conda install pyqtgraph

• Then type pip install -e .

Updating QCoDeS

from PyPi

pip install  --upgrade qcodes

Developer-pyenv/anaconda

cd $QCODES_INSTALL_DIR  && git pull

or if using GUIs, just pull the repo!

Docs

Read it here . Documentation is updated and deployed on every successful build in master.

We use sphinx for documentations, makefiles are provided both for Windows, and *nix.

Go to the directory docs and

make html

This generate a webpage, index.html, in docs/_build/html with the rendered html.

Contributing

See Contributing for information about bug/issue reports, contributing code, style, and testing

License

See License.