Skip to main content

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

Project description

QCoDeS PyPi DOCS PyPI python versions DOI

Build Status Github Build Status Github Docs Ruff OpenSSF

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.11+. 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.

Default branch is now main

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.

Install

In general, refer to here for installation.

Docs

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.txt

Go to the directory docs and

make html

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

QCoDeS Loop

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].

Code of Conduct

QCoDeS strictly adheres to the Microsoft Open Source Code of Conduct

Contributing

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.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or 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.

License

See License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qcodes-0.53.0.tar.gz (802.9 kB view details)

Uploaded Source

Built Distribution

qcodes-0.53.0-py3-none-any.whl (953.8 kB view details)

Uploaded Python 3

File details

Details for the file qcodes-0.53.0.tar.gz.

File metadata

  • Download URL: qcodes-0.53.0.tar.gz
  • Upload date:
  • Size: 802.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for qcodes-0.53.0.tar.gz
Algorithm Hash digest
SHA256 bc0791e2d206fac7d0cf1642c542361fe41f7d29c540128a83875bf188a18e52
MD5 5525a603fcfd12a17e6793261912f5d2
BLAKE2b-256 02ddc4afcc2899077eeba3b58509754fedc1d005cde0daa1ef94522bc4754b18

See more details on using hashes here.

Provenance

The following attestation bundles were made for qcodes-0.53.0.tar.gz:

Publisher: upload_to_pypi.yaml on microsoft/Qcodes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qcodes-0.53.0-py3-none-any.whl.

File metadata

  • Download URL: qcodes-0.53.0-py3-none-any.whl
  • Upload date:
  • Size: 953.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for qcodes-0.53.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1029cc3f8cf5e6eda827ec2150f955a37b9d21296ed6d582d289e71f406210f
MD5 063f928466b08f9bbe38cb7d0067a06b
BLAKE2b-256 806aa4cdf53e8899f2f910417b0114ff8d151a3feb9b4f6556c8a6cc81960e81

See more details on using hashes here.

Provenance

The following attestation bundles were made for qcodes-0.53.0-py3-none-any.whl:

Publisher: upload_to_pypi.yaml on microsoft/Qcodes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page