.. title:: Home

|LOGO|
======

.. image:: https://badge.fury.io/py/qcodes.svg
    :target: https://badge.fury.io/py/qcodes

.. image:: https://img.shields.io/badge/source-github-ff69b4.svg
   :target: https://github.com/QCoDeS/Qcodes

.. image:: https://zenodo.org/badge/37137879.svg
   :target: https://zenodo.org/badge/latestdoi/37137879

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

The goal is a common framework for physics experiments, so:

- new students don't need to spend a long time learning software in order to
  participate in experiments
- one has to write their own code only for pieces that are very specific
  to their own experiment
- code can and should be contributed back to the framework
- the process of moving between teams or labs, and of setting up
  a new experiment is streamlined
- physics experiments can take advantage of modern software and best practices

Read `15 minutes to QcoDeS <examples/15_minutes_to_QCoDeS.ipynb>`_ to have quick overview on QCoDeS.
Many more elaborate examples can be found in the `example notebooks <examples/index.rst>`__.



Documentation
-------------

.. toctree::
   :maxdepth: 2

   start/index
   examples/15_minutes_to_QCoDeS
   examples/index
   community/index
   dataset/index
   api/index
   drivers_api/index
   changes/index
   help


Indices and tables
==================


* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

License
=======

.. include:: ../LICENSE


Contributions
=============

QCoDeS logo contributed by `Guenevere E D K Prawiroatmodjo <bqv662@alumni.ku.dk>`_

.. |LOGO|  image:: ./logos/qcodes_logo.png
   :scale: 50 %
   :alt: qcodes logo