Welcome to QCoDeS Contributed Drivers’s documentation!¶
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.
Default branch is now main¶
The default branch in qcodes_contrib_drivers has been remamed to main. If you are working with a local clone of qcodes_contrib_drivers you should update it as follows.
Run
git fetch originandgit checkout mainRun
git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/mainto update your HEAD reference.
Getting started¶
Prerequisites¶
The drivers in this repository work with and heavily depend on QCoDeS. Start by installing QCoDeS .
Installation¶
Install the contrib drivers with pip
pip install qcodes_contrib_drivers
Drivers documentation¶
The documentations of the drivers in this repository can be read here.
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. Especially the examples here are useful.
LICENSE¶
QCoDeS-Contrib-drivers is licensed under the MIT license except the Tektronix AWG520 and
Tektronix Keithley 2700 drivers which are licensed under the GPL 2 or later License.
The documentation here contains API documentation of the individual drivers as well as examples of how to use the drivers. For general documentation please refer to the QCoDeS documentation.
Contents:
- Examples of how to use drivers
- Example with the Agilent N9000A
- Example notebook for AimTTi EL320P
- Qcodes example with Andor DU401 BU2
- QCoDeS example with Attocube ANC300
- Qcodes example with Aviosys IP Power 9258S
- Example with the BlueFors
- Example with CopperMountain Model M5180 vector network analyzer
- Setup db and station for test measurerment
- Look at the names and the labels of the Sxx parameters
- Example with ERASynth
- QCoDeS Example with Gentec Maestro
- Example notebook for the Holzworth HS900B RF synthesizer
- Example for Horiba FHR
- Example with the iTest from Bilt
- Example notebook for Keithley 6430 SMU
- Measure resistance of a ~100k\(\Omega\) resistor
- Keysight M3202A AWG
- Keysight M3202A AWG example with digitizer
- Qcodes example with Lakeshore 311
- Example with Lakeshore Model 625 Superconducting Magnet power supply
- National Instruments Multifunction DAQ example
- Qcodes example for National Instruments PXIe-2597 RF Switch
- Qcodes example with the NI RFSG signal generator driver
- QCoDeS Example with Newport AG-UC8 Piezo Motion Controller
- Proteox system integration with QCoDeS
- Example of the oxford triton driver
- QCoDeS example with Rigol DSG3136B
- QCoDeS Example with R&S HMC 8043 Power Supply
- QCoDeS Example with R&S HMP4040 Power Supply
- QCoDeS example with Rohe&Schwarz SMW200A
- Changing the Sensitivity
- Preparing for reading the buffer and measurement
- Qcodes example with Shamrock SR750
- Example with the microwave source SC5521A from Signal Core
- Device connection
- Set parameters
- Example of Signal Recovery 7270 driver usage
- Example for Single Quantum SNSPD
- Qcodes example with Standa 10MWA168
- Qcodes example with Swabian Instruments Time Tagger
- Tektronix AFG3000 series arbitrary function generator
- overview over all parameters
- Usage of the two main parameters
- QCoDeS Example with Tektronix Keithley Digital Multimeter DMM6500
- Qcodes example with Thorlabs K10CR1
- QCoDeS example with Thorlabs KLS1550 laser source
- Qcodes example with Thorlabs MFF10x
- Qcodes example with Thorlabs PRM1Z8
- QCoDeS example with Valon 5015
- Qcodes example for Vaunix LDA step attenuator
- Model with many channels
- Rohde & Schwarz ZVL13 Vector Network Analyzer example
- Parameters definition
- Zurich Instruments HF2LI example
- QDevil drivers
- QCoDeS Example with HP8594E
- qcodes_contrib_drivers.drivers package