Metadata-Version: 2.1
Name: qcodes
Version: 0.16.0
Summary: Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium
Home-page: https://github.com/QCoDeS/Qcodes
Maintainer: Jens H Nielsen
Maintainer-email: Jens.Nielsen@microsoft.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.10)
Requires-Dist: pyvisa (>=1.9.1)
Requires-Dist: h5py (>=2.6)
Requires-Dist: websockets (>=7.0)
Requires-Dist: jsonschema
Requires-Dist: ruamel.yaml (!=0.16.6)
Requires-Dist: pyzmq
Requires-Dist: wrapt
Requires-Dist: pandas
Requires-Dist: tabulate
Requires-Dist: tqdm
Requires-Dist: opencensus-ext-azure
Requires-Dist: matplotlib (>=2.2.3)
Requires-Dist: requirements-parser
Requires-Dist: typing-extensions
Requires-Dist: packaging (>=20.0)
Requires-Dist: dataclasses ; python_version < "3.7"
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: matplot
Requires-Dist: matplotlib (>=2.2.3) ; extra == 'matplot'
Provides-Extra: qtplot
Requires-Dist: pyqtgraph (>=0.11.0) ; extra == 'qtplot'
Provides-Extra: slack
Requires-Dist: slacker (>=0.9.42) ; extra == 'slack'
Provides-Extra: zurichinstruments
Requires-Dist: zhinst-qcodes (>=0.1.1) ; extra == 'zurichinstruments'
Provides-Extra: coverage_tests
Requires-Dist: coverage (>=4.0) ; extra == 'coverage_tests'

QCoDeS |Build Status Azure| |Build Status Travis| |DOCS| |DOI|
==============================================================

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 <http://qcodes.github.io/Qcodes>`_ .

To get a feeling of QCoDeS read
`15 minutes to QCoDeS <http://qcodes.github.io/Qcodes/examples/15_minutes_to_QCoDeS.html>`__,
and/or browse the Jupyter notebooks in `docs/examples
<https://github.com/QCoDeS/Qcodes/tree/master/docs/examples>`__ .

QCoDeS is compatible with Python 3.6+. 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 <http://qcodes.github.io/Qcodes/start/index.html#installation>`__
for installation.


Docs
====

Read it `here <http://qcodes.github.io/Qcodes>`__ .
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

.. code:: bash

    pip install -r docs_requirements.txt

Go to the directory ``docs`` and

.. code:: bash

    make html-api

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

Code of Conduct
===============

QCoDeS strictly adheres to the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`__


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 <https://github.com/QCoDeS/Qcodes/tree/master/CONTRIBUTING.rst>`__ for general information about bug/issue
reports, contributing code, style, and testing.



License
=======

See `License <https://github.com/QCoDeS/Qcodes/tree/master/LICENSE.rst>`__.

.. |Build Status Azure| image:: https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_apis/build/status/QCoDeS.Qcodes%20(public)?branchName=master
    :target: https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_build/latest?definitionId=8&branchName=master
.. |Build Status Travis| image:: https://travis-ci.com/QCoDeS/Qcodes.svg?branch=master
    :target: https://travis-ci.com/QCoDeS/Qcodes
.. |DOCS| image:: https://img.shields.io/badge/read%20-thedocs-ff66b4.svg
   :target: http://qcodes.github.io/Qcodes
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3903234.svg
   :target: https://doi.org/10.5281/zenodo.3903234


