Metadata-Version: 2.1
Name: qcodes
Version: 0.0.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: QCoDeS Core Developers
Maintainer-email: qcodes-support@microsoft.com
License: MIT
Project-URL: Documentation, https://qcodes.github.io/Qcodes/
Project-URL: Source, https://github.com/qcodes/qcodes
Project-URL: Tracker, https://github.com/QCoDeS/Qcodes/issues
Project-URL: Changelog, https://qcodes.github.io/Qcodes/changes/index.html
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: LICENSE.rst
Requires-Dist: numpy (>=1.17.0)
Requires-Dist: pyvisa (<1.12.0,>=1.11.0)
Requires-Dist: h5py (>=3.0.0)
Requires-Dist: websockets (>=7.0)
Requires-Dist: jsonschema (>=3.0.0)
Requires-Dist: ruamel.yaml (!=0.16.6,>=0.16.0)
Requires-Dist: wrapt (>=1.10.4)
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: xarray (>=0.18.0)
Requires-Dist: tabulate (>=0.8.0)
Requires-Dist: tqdm (>=4.32.2)
Requires-Dist: opencensus (<0.9.0,>=0.7.10)
Requires-Dist: opencensus-ext-azure (<2.0.0,>=1.0.4)
Requires-Dist: matplotlib (>=3.3.0)
Requires-Dist: typing-extensions (>=3.10.0)
Requires-Dist: packaging (>=20.0)
Requires-Dist: ipywidgets (>=7.5.0)
Requires-Dist: broadbean (>=0.9.1)
Requires-Dist: uncertainties (>=3.1.4)
Requires-Dist: h5netcdf (!=0.14.0,>=0.10.0)
Requires-Dist: setuptools (>=48)
Requires-Dist: versioningit (>=0.3.0)
Requires-Dist: ipython (!=8.0.0,>=7.31.1)
Requires-Dist: pillow (>=9.0.0)
Requires-Dist: rsa (>=4.7)
Requires-Dist: importlib-metadata (<5.0.0,>=3.6.0) ; python_version < "3.8"
Provides-Extra: qtplot
Requires-Dist: pyqtgraph (>=0.11.0) ; extra == 'qtplot'
Provides-Extra: slack
Requires-Dist: slack-sdk (>=3.4.2) ; extra == 'slack'
Provides-Extra: zurichinstruments
Requires-Dist: zhinst-qcodes (>=0.3) ; extra == 'zurichinstruments'
Provides-Extra: test
Requires-Dist: pytest (>=6.0.0) ; extra == 'test'
Requires-Dist: PyVisa-sim (>=0.4.0) ; extra == 'test'
Requires-Dist: hypothesis (>=5.49.0) ; extra == 'test'
Requires-Dist: pytest-xdist (>=2.0.0) ; extra == 'test'
Requires-Dist: deepdiff (>=5.0.2) ; extra == 'test'
Requires-Dist: pytest-mock (>=3.0.0) ; extra == 'test'
Requires-Dist: pytest-rerunfailures (>=5.0.0) ; extra == 'test'
Requires-Dist: lxml (>=4.3.0) ; extra == 'test'
Requires-Dist: types-requests (>=0.1.8) ; extra == 'test'
Requires-Dist: types-setuptools (>=57.0.0) ; extra == 'test'
Requires-Dist: types-tabulate (>=0.1.0) ; extra == 'test'
Requires-Dist: Sphinx (>=4.1.2) ; extra == 'test'

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

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 Github| image:: https://github.com/QCoDeS/Qcodes/workflows/Run%20mypy%20and%20pytest/badge.svg
    :target: https://github.com/QCoDeS/Qcodes/actions?query=workflow%3A%22Run+mypy+and+pytest%22
.. |Build Status Github Docs| image:: https://github.com/QCoDeS/Qcodes/workflows/build%20docs/badge.svg
    :target: https://github.com/QCoDeS/Qcodes/actions?query=workflow%3A%22build+docs%22
.. |Codacy badge| image:: https://api.codacy.com/project/badge/Grade/6c9e0e5712bf4c6285d6f717aa8e84fa
    :alt: Codacy Badge
    :target: https://app.codacy.com/manual/qcodes/Qcodes?utm_source=github.com&utm_medium=referral&utm_content=QCoDeS/Qcodes&utm_campaign=Badge_Grade_Settings
.. |PyPi| image:: https://badge.fury.io/py/qcodes.svg
    :target: https://badge.fury.io/py/qcodes
.. |PyPI python versions| image:: https://img.shields.io/pypi/pyversions/qcodes.svg
    :target: https://pypi.python.org/pypi/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/37137879.svg
   :target: https://zenodo.org/badge/latestdoi/37137879


