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 Codacy Badge

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

Install

In general, refer to here for installation.

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

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.40.0.tar.gz (985.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qcodes-0.40.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qcodes-0.40.0.tar.gz
  • Upload date:
  • Size: 985.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for qcodes-0.40.0.tar.gz
Algorithm Hash digest
SHA256 0bcfe5b57ded4b109b6e17ae7a5dc18c8911065fc4f7694aef4f50631fb614bd
MD5 279cdc502516905d74f3f753e7e85e3a
BLAKE2b-256 16682b3314bf47eae4e8c611bbc23cf1220b7dad3eaf583cc20cb9b60d89ef4f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qcodes-0.40.0-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for qcodes-0.40.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d31a33f5516df0126e6db33069b072366a8fc1790029a03d09013bb0008701a
MD5 90e75ad46b1ec3810b9218acb63797dd
BLAKE2b-256 5d8b40c4367985d60ad96cb7127edac9a79dacd39123b347bcfe6f059ee3482f

See more details on using hashes here.

Supported by

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