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 read 15 minutes to QCoDeS, and/or browse the Jupyter notebooks in docs/examples .
QCoDeS is compatible with Python 3.9+ (3.9 soon to be deprecated). 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. The features in qcodes.utils.magic are exclusively for Jupyter notebooks.
The default branch in QCoDeS has been renamed to main. If you are working with a local clone of QCoDeS you should update it as follows:
- Run git fetch origin and git checkout main
- Run git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main to update your HEAD reference.
In general, refer to here for installation.
Read it here . Documentation is updated and deployed on every successful build in main.
We use sphinx for documentations, makefiles are provided both for Windows, and *nix, so that you can build the documentation locally.
Make sure that you have the extra dependencies required to install the docs
pip install -r docs_requirements.txtGo to the directory docs and
make htmlThis generate a webpage, index.html, in docs/_build/html with the
rendered html.
The modules qcodes.data, qcodes.plots, qcodes.actions,
qcodes.loops, qcodes.measure, qcodes.extensions.slack
and qcodes.utils.magic that were part of QCoDeS until version 0.37.0.
have been moved into an independent package called qcodes_loop.
Please see it's repository and
documentation for more information.
For the time being it is possible to automatically install the qcodes_loop
package when installing qcodes by executing pip install qcodes[loop].
QCoDeS strictly adheres to the Microsoft Open Source Code of Conduct
The QCoDeS instrument drivers developed by the members of the QCoDeS community but not supported by the QCoDeS developers are contained in
https://github.com/QCoDeS/Qcodes_contrib_drivers
See Contributing for general information about bug/issue reports, contributing code, style, and testing.
See License.