Metadata-Version: 1.2
Name: qcodes-contrib-drivers
Version: 0.5.0
Summary: User contributed drivers for QCoDeS
Home-page: https://github.com/QCoDeS/Qcodes_contrib_drivers
Maintainer: Jens H Nielsen
Maintainer-email: Jens.Nielsen@microsoft.com
License: MIT
Description: ######################
        QCoDeS contrib drivers
        ######################
        
        This repository contains QCoDeS instrument drivers developed by members of the QCoDeS community.
        These drivers are not supported by the QCoDeS developers but instead supported on a best effort basis
        by the developers of the individual drivers.
        
        Getting started
        ###############
        
        Prerequisites
        *************
        
        The drivers in this repository work with and heavily depend on QCoDeS. Start by installing `QCoDeS <https://github.com/QCoDeS/Qcodes>`_ .
        
        Installation
        ************
        
        Install the contrib drivers with ``pip``
        
        .. code-block::
        
          pip install qcodes_contrib_drivers
        
        Contributing
        ############
        
        This repository is open for contribution of new drivers, 
        as well as improvements to existing drivers. Each driver should
        contain an implementation of the driver and a Jupyter notebook showing how the
        driver should be used. In addition we strongly encourage writing tests for the drivers.
        An introduction for writing tests with PyVISA-sim can be found in the QCoDeS documentation linked
        below.
        
        Drivers are expected to be added to ``qcodes_contrib_drivers/drivers/MakerOfInstrument/`` folder
        while examples should be added to the ``docs/examples`` folder and tests placed in the
        ``qcodes_contrib_drivers/tests/MakerOfInstrument`` folder. Please follow naming conventions for
        consistency.
        
        For general information about writing drivers and how to write tests refer to the `QCoDeS documentation <http://qcodes.github.io/Qcodes/>`_.
        Especially the examples `here <https://qcodes.github.io/Qcodes/examples/index.html#writing-drivers>`__
        are useful.
        
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: Topic :: Scientific/Engineering
