Repository files navigation

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

To get a feeling of QCoDeS read15 minutes to QCoDeS,and/or browse the Jupyter notebooks indocs/examples .

QCoDeS is compatible with Python 3.11+. It isprimarily intended for use from Jupyter notebooks, but can be used fromtraditional terminal-based shells and in stand-alone scripts as well. Thefeatures 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 toherefor installation.

Read ithere .Documentation is updated and deployed on every successful build in main.

We use sphinx for documentations, makefiles are provided both forWindows, 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.txt

Go to the directorydocs and

make html

This generate a webpage, index.html, indocs/_build/html with therendered html.

The modulesqcodes.data,qcodes.plots,qcodes.actions,qcodes.loops,qcodes.measure,qcodes.extensions.slackandqcodes.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'srepository anddocumentation for more information.

For the time being it is possible to automatically install the qcodes_looppackage when installing qcodes by executingpip install qcodes[loop].

QCoDeS strictly adheres to theMicrosoft Open Source Code of Conduct

The QCoDeS instrument drivers developed by the members ofthe QCoDeS community but not supported by the QCoDeS developers are contained in

https://github.com/QCoDeS/Qcodes_contrib_drivers

SeeContributing for general information about bug/issuereports, contributing code, style, and testing.

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks orlogos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarksor logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.Any use of third-party trademarks or logos are subject to those third-party’s policies.

SeeLicense.