Metadata-Version: 2.1
Name: qcodes
Version: 0.15.0a1
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
Description: 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.
        
        Status
        ------
        QCoDeS is still in development, more documentation and features will be coming!
        The team behind this project just expanded.  There are still rough edges, and
        gray areas but QCoDeS has been running without major issue in two long running
        experiments.
        
        The most important features in the roadmap are:
        
        - a more flexible and faster data storage solution
        - a robust architecture that uses the full potential of your hardware
        
        
        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.
        
        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.3832741.svg
           :target: https://doi.org/10.5281/zenodo.3832741
        
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
Provides-Extra: MatPlot
Provides-Extra: QtPlot
Provides-Extra: coverage tests
Provides-Extra: Slack
Provides-Extra: ZurichInstruments
