Metadata-Version: 2.1
Name: qcodes
Version: 0.47.0
Summary: Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium
Maintainer-email: QCoDeS Core Developers <qcodes-support@microsoft.com>
License: MIT
Project-URL: Homepage, https://github.com/QCoDeS/Qcodes
Project-URL: Documentation, https://microsoft.github.io/Qcodes/
Project-URL: Source, https://github.com/qcodes/qcodes
Project-URL: Tracker, https://github.com/QCoDeS/Qcodes/issues
Project-URL: Changelog, https://microsoft.github.io/Qcodes/changes/index.html
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: broadbean >=0.11.0
Requires-Dist: h5netcdf >=0.14.1
Requires-Dist: h5py >=3.6.0
Requires-Dist: ipywidgets <9.0.0,>=8.0.0
Requires-Dist: ipykernel >=6.6.0
Requires-Dist: jsonschema >=4.9.0
Requires-Dist: matplotlib >=3.5.0
Requires-Dist: numpy >=1.22.4
Requires-Dist: packaging >=20.0
Requires-Dist: pandas >=1.4.0
Requires-Dist: pyarrow >=11.0.0
Requires-Dist: pyvisa <1.15.0,>=1.11.0
Requires-Dist: ruamel.yaml !=0.16.6,>=0.16.0
Requires-Dist: tabulate >=0.9.0
Requires-Dist: typing-extensions >=4.6.0
Requires-Dist: tqdm >=4.59.0
Requires-Dist: uncertainties >=3.1.4
Requires-Dist: versioningit >=2.2.1
Requires-Dist: websockets >=11.0
Requires-Dist: xarray >=2022.06.0
Requires-Dist: cf-xarray >=0.8.4
Requires-Dist: opentelemetry-api >=1.15.0
Requires-Dist: dask >=2022.1.0
Requires-Dist: tornado >=6.3.3
Requires-Dist: ipython >=8.10.0
Requires-Dist: pillow >=9.0.0
Requires-Dist: wrapt >=1.14.0 ; python_version < "3.12"
Requires-Dist: wrapt >=1.16.0 ; python_version >= "3.12"
Provides-Extra: docs
Requires-Dist: autodocsumm >=0.2.9 ; extra == 'docs'
Requires-Dist: nbsphinx >=0.8.9 ; extra == 'docs'
Requires-Dist: PyVisa-sim >=0.6.0 ; extra == 'docs'
Requires-Dist: sphinx >=7.3.5 ; extra == 'docs'
Requires-Dist: sphinx-favicon >=1.0 ; extra == 'docs'
Requires-Dist: sphinx-issues >=3.0.1 ; extra == 'docs'
Requires-Dist: sphinx-jsonschema >=1.19.1 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'docs'
Requires-Dist: sphinxcontrib-towncrier >=0.3.0a0 ; extra == 'docs'
Requires-Dist: towncrier >=22.8.0 ; extra == 'docs'
Requires-Dist: scipy >=1.8.0 ; extra == 'docs'
Requires-Dist: qcodes-loop >=0.1.1 ; extra == 'docs'
Requires-Dist: jinja2 >=3.1.3 ; extra == 'docs'
Provides-Extra: loop
Requires-Dist: qcodes-loop >=0.1.2 ; extra == 'loop'
Provides-Extra: opencensus
Requires-Dist: opencensus >=0.7.10 ; extra == 'opencensus'
Requires-Dist: opencensus-ext-azure <2.0.0,>=1.0.4 ; extra == 'opencensus'
Provides-Extra: refactor
Requires-Dist: libcst >=1.2.0 ; extra == 'refactor'
Provides-Extra: test
Requires-Dist: coverage[toml] >=6.0.0 ; extra == 'test'
Requires-Dist: deepdiff >=5.0.2 ; extra == 'test'
Requires-Dist: hypothesis >=6.85.0 ; extra == 'test'
Requires-Dist: lxml >=4.8.0 ; extra == 'test'
Requires-Dist: lxml-stubs >=0.4.0 ; extra == 'test'
Requires-Dist: mypy >=0.971 ; extra == 'test'
Requires-Dist: pandas-stubs >=1.2.0.1 ; extra == 'test'
Requires-Dist: pytest >=7.2.0 ; extra == 'test'
Requires-Dist: pytest-asyncio >=0.19.0 ; extra == 'test'
Requires-Dist: pytest-cov >=3.0.0 ; extra == 'test'
Requires-Dist: pytest-mock >=3.0.0 ; extra == 'test'
Requires-Dist: pytest-rerunfailures >=10.0 ; extra == 'test'
Requires-Dist: pytest-xdist >=2.5.0 ; extra == 'test'
Requires-Dist: PyVisa-sim >=0.6.0 ; extra == 'test'
Requires-Dist: sphinx >=4.5.0 ; extra == 'test'
Requires-Dist: types-jsonschema >=4.16.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: types-tqdm >=4.64.6 ; extra == 'test'
Requires-Dist: types-pywin32 >=305.0.0.7 ; extra == 'test'
Requires-Dist: qcodes-loop >=0.1.1 ; extra == 'test'
Requires-Dist: zhinst.qcodes >=0.5 ; extra == 'test'
Requires-Dist: libcst >=1.2.0 ; extra == 'test'
Requires-Dist: jinja2 >=3.1.3 ; extra == 'test'
Provides-Extra: zurichinstruments
Requires-Dist: zhinst-qcodes >=0.3 ; extra == 'zurichinstruments'

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

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

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


Docs
====

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

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

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 <https://github.com/QCoDeS/Qcodes_loop/>`_ and
`documentation <https://microsoft.github.io/Qcodes_loop/>`_ 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 <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/main/CONTRIBUTING.rst>`__ for general information about bug/issue
reports, contributing code, style, and testing.



License
=======

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

.. |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+branch%3Amain
.. |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+branch%3Amain
.. |Ruff|  image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff
.. |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://microsoft.github.io/Qcodes
.. |DOI| image:: https://zenodo.org/badge/37137879.svg
   :target: https://zenodo.org/badge/latestdoi/37137879
.. |OpenSSF| image:: https://api.securityscorecards.dev/projects/github.com/microsoft/Qcodes/badge
   :target: https://securityscorecards.dev/viewer/?uri=github.com/microsoft/Qcodes
