Examples of using QCoDeS

These are all examples based on notebooks that can be found in https://github.com/QCoDeS/Qcodes/tree/master/docs/examples and below. To experiment with the examples you can download them directly from the git repository.

Basic examples

• 15 minutes to QCoDeS
  • Introduction
  • Installation
  • Module imports
  • Instruments
  • Parameters
    • Example of setting and getting parameters
  • Stations
    • Adding instruments to the station
    • Inspecting the station
    • Saving and loading configurations.
  • Databases and experiments.
    • Initialize or create a database
    • Load or create an experiment
  • Measurement Context Manager
    • Registering parameters to measure
    • Example measurement loop
  • Using the doNd multi-dimensional measurement utility
  • Exploring datasets and databases
    • List all datasets in a database.
    • List all the datasets in an experiment
    • Load the data set using one or more specifications
    • Plotting datasets
    • QCoDeS measurements live plotting with Plottr
    • Get data of specific parameter of a dataset
    • Export data to pandas dataframe
    • Export data to xarray
    • Explore the data using an interactive widget
  • Further Reading
    • QCoDeS configuration
    • QCoDeS instrument drivers
    • QCoDeS logging
• QCoDeS config
  • Configuring QCoDeS
  • Saving changes
    • Using custom variables in your experiment:
  • Changing core values
• QCoDeS Tutorials
  • Logging
  • Plotting
• Station
  • What is a Station?
  • How to create a Station and work with it?
    • Creating a Station
    • Accessing Station components
    • Removing components from a Station
    • Default Station
  • Snapshot of a Station
  • Configuring the Station by using a YAML configuration file
    • Example of YAML Station configuration
    • QCoDeS configuration entries related to Station
    • Using Station with YAML configuration files
    • Setting up Visual Studio Code to work with station files

Parameters

These notebooks provide some examples of how to tweak and customize the QCoDeS parameters to achieve different ends.

• Complex Numbers
  • Complex-valued parameters
    • Scalar-valued parameters
    • Array-valued parameters
• Legacy parameter examples
  • ArrayParameter
• MultiParameter
• ParameterWithSetpoints with setpoints defined on another instrument.
  • Measurement
• Parameters in QCoDeS
  • Responsibilities
  • Examples
    • Imports
    • Simple parameter subclass
      • Parameter definition
      • Demonstration of the get method
      • Demonstration of the set method
      • Inspecting parameter attributes
    • Virtual Parameters
      • Manually creating a virtual parameter
      • Instrument Parameters
• ScaledParameter
  • Resistive voltage divider
  • Voltage multiplier
  • Transimpedance amplifier
• Simple Example of ParameterWithSetpoints
  • Measurement
  • Measure a ParameterWithSetpoints while sweeping another parameter

DataSet

• Accessing data in a DataSet
  • Preparation: a DataSet from a dummy Measurement
  • DataSet indentification
  • Parameters in the DataSet
    • Run description
    • Interdependencies
      • Dependencies, inferences, standalones
      • ParamSpecBase objects
      • Other useful methods and properties
    • Shortcuts to important parameters
    • Note on inferences
    • Note on ParamSpec’s
  • Getting data from DataSet
    • get_parameter_data - the powerhorse
      • Avoid excessive calls to loading data
      • Loading data of selected parameters
    • to_pandas_dataframe_dict and to_pandas_dataframe - for pandas fans
    • Exporting to other file formats
    • Data extraction into “other” formats
• Dataset Benchmarking
  • Setup
  • Baseline: Generate data
  • Add to dataset inside double loop
  • Add the data in outer loop and store as np array
  • Save once after loop
  • Array parameter
  • Insert many
• DataSet class walkthrough
  • Note on DataSet object creation
  • Preparation: a DataSet from a dummy Measurement
  • Note on immutability of DataSet
  • DataSet indentity
    • GUID
    • Captured run ID
      • Note on run ID
    • Experiment and sample names
    • DataSet name
    • Note on experiments
      • Note on counter
  • DataSet info
    • Database file
    • Timestamps
    • Snapshot
    • Parent dataset links
    • Note on DataSet states
    • Note on metadata
  • Parameters in DataSet
    • Interdependencies
    • Shortcuts to important parameters
    • Note on ParamSpec’s
  • Data access in DataSet
    • Not recommended data access methods
  • What about the rest?
• Databases
  • Imports
  • Initialization, creation and upgrade
• DataSet Performance
  • Comparison between numeric/array data and binary blob
    • Case1: Short experiment time
    • Case2: Long experiment time
  • Loading the data
• Exporting QCoDes Datasets
  • Setup
  • Exporting data manually
  • Export data automatically
  • Automatically post process exported datasets.
  • Importing exported datasets into a new database
• Extracting runs from one DB file to another
  • Setup
  • Extraction
  • Merging data from 2 databases
  • Uniquely identifying and loading runs
• In memory dataset
  • Reloading data from db and exported file
• Linking to parent datasets
  • Example 1: Measuring and then fitting
    • Step 1: measure raw data
    • Step 2: Set up a fit “measurement”
• Measuring X as a function of time
  • Prepatory footwork: setup database and experiment
    • The measurement itself
• Offline Plotting Tutorial
  • A single, simple 1D sweep
    • Rescaling units and ticks
  • Two interleaved 1D sweeps
  • Regular 2D rectangular sweep scan
    • Customisations
      • Changing the colormap
      • Setting the colorscale to logarithmic
      • Setting limits on the colorscale
  • Warped 2D rectangular sweep scan
  • Interrupted 2D scans (a hole in the cheese)
  • Fancy plotting
  • Rasterizing
• Offline plotting with categorical data
  • 1D plotting
    • Category is the independent parameter
    • Category is the dependent parameter
  • Both variables are categorical
  • 2D plotting
    • Categorical data on the x-axis
    • Categorical data on the y-axis
    • Categorical data on the z-axis
      • Gridded setpoints
      • Scattered setpoints
    • Categorical data on x-axis and z-axis
• Offline plotting with complex data
  • Case A: a complex number as a function of a real number
  • Case B: a complex number as a function of two real numbers
  • Case C: a real number as a function of a complex number
• Paramtypes explained
  • Numeric
    • Numeric example 1
  • Array
    • Array example 1
    • Array example 2
    • Array example 3
  • Text
• Pedestrian example of subscribing to a DataSet
  • Call signature
  • Frequency
  • Order
    • Example 1: A notification
    • Example 2: ASCII Plotter
• Performing measurements using QCoDeS parameters and DataSet
  • Implementing a measurement
  • Accessing and exporting the measured data
  • Reloading datasets
    • DataSet GUID
  • Specifying shape of measurement
  • Performing several measuments concurrently
  • Interrupting measurements early
  • QCoDeS Array and MultiParameter
  • Avoiding verbosity of the Measurement context manager for simple measurements
  • Optimizing measurement time
  • The power of the Measurement context manager construct
    • Finer sampling in 2D
    • Simple adaptive 2D sweep
    • Random sampling
    • Optimiser
  • Subscriptions
    • Subscription example 1: simple printing
    • Subscription example 2: using the state
• Saving data in the background
  • Can I haz speedup?
  • Example Measurement
  • Data saving in the main thread
  • Saving in a background thread
  • Conclusion
• The Experiment Container
  • Required imports
  • The experiments inside the database
• Threaded data acquisition
  • Measurement 1: Non threaded data acquisition
  • Measurement 2: Threaded data acquisition
  • Non threaded and threaded data acquisition with do1d
    • Measurement 3: Non threaded data acquisition with do1d
    • Measurement 4: Threaded data acquisition with do1d
• Using doNd functions in comparison to Measurement context manager for performing measurements
  • Setup before measurement
  • 1D measurement
    • Measurement
    • do1d
  • 2D measurement
    • Measurement
    • do2d
  • Handling plot, experiment, and measurement_name with doNd
  • Generalized n-dimensional measurement (dond)
  • dond with multiple measurements (multiple datasets)
  • Sweep multiple parameters in parallel
  • Getting a value after setting it.
  • Actions in dond
• Working with snapshots
  • Useful imports
    • What is a snapshot?
    • How to create a snapshot?
  • Snapshot example for Parameter object
  • Snapshot of an Instrument
  • Station and its snapshot
    • Saving snapshot next to the measurement data
    • Extracting snapshot from dataset
    • Comparing how two DataSets were taken
• Working with Pandas and XArray
  • Setup
  • Working with Pandas
  • Working with XArray
• Importing data from legacy .dat files
• Subscriber with JSON export
• Example Measurements with Real Instruments
  • Measurement 1: Frequency sweeps
  • Measurement 2: Triangle Traces
• Read data from cache
• Write data to cache

Plotting

• How to use Plottr with QCoDeS for live plotting?
  • Mock Set-up
  • Initialize/Create Database
  • Launch Plottr Inspectr
    • If plottr is installed in same environment as measurements environment
  • Measurement
    • Measurement with run context manager
    • Measurement with doNd
  • Live Plot
• Auto Color Scale
  • TL;DR
  • Table of contents
  • Introduction to the problem and risks
  • Using the automatic color scale
    • Exampe 1: outliers in homogeneous data
  • Cuttoff Percentiles
    • Example 2: data on noisy background with outliers
    • Asymmetric cutoffs
  • Defaults and customizing the auto color scaling
  • Using auto color scaling in custom plotting

Drivers

• QCoDeS Example with Keysight E4980A LCR meter
• QCoDeS Example with Yokogawa GS200 and Keithley 7510 Multimeter
• QCoDeS example with Aim TTi PL601-P
• Qcodes example with DelegateInstrument driver
• QCoDeS example with Galil DMC4133 Controller
• Qcodes example with InstrumentGroup driver
• QCoDeS example with Keithley 3706A System Switch
• QCoDeS Example with Tektronix Keithley S46
• QCoDeS Example with the Rigol DG 1062 Instrument
• QCoDeS example with Textronix DPO 7200xx scopes
• QCoDeS Example with AMI430
• QCoDeS Example with Agilent 34400A
• QCoDeS Example with Alazar ATS 9360
• Qcodes example with Basel SP983c Preamp and its Remote SP983a
• QCoDeS Example with DynaCool PPMS
• QCoDeS Example with HP8753D
• QCoDeS Example with Itacho
• QCoDeS Example with with Keithley 2600 series
• QCoDeS Example with Tektronix Keithley 7510 Multimeter
• QCoDeS Example with Keysight 33500B
• QCoDeS Example with Keysight 344xxA
• QCoDeS Example with Keysight 34980A Multifunction Switch / Measure Mainframe and Modules
• Qcodes example with Keysight B1500 Semiconductor Parameter Analyzer
• QCoDeS Example with Keysight B2200 Series Femto Leakage Switch Matrix
• QCoDeS Example with Keysight Infiniium Oscilloscopes
• Qcodes example with Keysight N9030B
• QCoDeS Example with Keysight Network Analyzers
• QCoDeS Example with Lakeshore 325
• QCoDeS Example with the Lakeshore Model 372 to Control the Temperature of the Bluefors Fridge
• QCoDeS Example with Minicircuits Switch Boxes Controlled via USB
• QCoDeS Example with Mercury iPS
• QCoDeS Example with Oxford Triton
• QCoDeS Example with QDac_channels
• QCoDeS Example with Rigol DP832 Power Supply
• QCoDeS Example with the Rigol DS 1074 Z oscilloscope
• QCoDeS Example with Rohde Schwarz RTO 1000 Series Oscilloscope
• QCoDeS Example with Rohde Schwarz SGS100A RF source
• QCoDeS Example with Rohde Schwarz ZNB20/8
• QCoDeS Example with the Stahl Bias Sources
• QCoDeS Example with Stanford SR830
• QCoDeS Example with Standford Research SR86x Lock-in Amplifier with Buffered Readout
• QCoDeS Example with Tektronix AWG5014
• QCoDeS Example with Tektronix AWG70002A
• QCoDeS Example with Tektronix TPS2012
• QCoDeS Example with Yokogawa GS200/GS210
• QCoDeS Example with Tektronix Keithley 2450 Source Meter
• QCoDeS+Broadbean Example with Tektronix AWG5208
• QCoDeS Example with Signal Hound USB-SA124B
• QCoDeS Example with Signal Hound USB-SA124B ParameterWithSetpoints

Writing Drivers

This folder contains examples that are useful when you want to write your own driver for a new instrument.

• A ParameterWithSetpoints Example with Dual Setpoints
  • Measurement 1: Time Trace
  • Measurement 2: Periodogram
  • Measurement 3: 2D Sweeping
• Creating QCoDeS instrument drivers
  • Base Classes
  • Parameters and Channels
    • What’s a Parameter?
    • Functions
    • What’s an InstrumentModule, then?
  • Naming Instruments
    • Naming the Instrument class
    • Naming InstrumentModule classes
    • Driver supporting multiple models.
  • Logging
  • VisaInstrument: a more involved example
  • VisaInstruments: Simulating the instrument
  • DLL-based instruments
  • Manual instruments
  • Custom Parameter classes
    • On/Off parameters
  • Dynamically adding and removing parameters
  • Handling interruption of measurements
  • Organization
  • Documentation
• Creating Simulated PyVISA Instruments
  • What?
  • Not!
  • How?
  • Example: Weinschel8320
    • The .yaml file
    • The test
  • Congratulations! That was it.
  • Bonus example: including parameters in the simulated instrument
  • That’s it!
• Instrument
  • Instrument responsibilities:
  • Instruments can fail:
  • Example notebooks about Instruments:
• Abstract Instruments and parameters
  • We cannot instantiate a Instrument with abstract parameters.
  • Units of parameters defined in sub classes must match units defined in the base class
• Working subclass

Logging

• Logfile parsing
  • Get the query time for the SR860
  • Find the elapsed times
    • Visualise!
• Logging
  • TL;DR
  • Contents
  • Introduction
  • Instrument communication loggers
  • Set up logging in QCoDeS
    • QCoDeS default handlers
    • IPython command history
  • Temporarily elevating the logging level
  • Filtering log messages by instrument
  • Capturing Pandas.DataFrame

Legacy examples

This folder contains examples of the legacy QCoDeS dataset and plotting utilities. They are not recommended for new users but may be useful as reference for existing users.

• Combined Parameters
  • Simple combined parameters
  • Combine and aggregate parameters
• Comprehensive Plotting How-To
  • MatPlot
    • Simple 1D sweep
    • Subplots
    • 2D Plots
    • Interfacing with Matplotlib
    • Event handling
• Datasaving Examples
  • Start a loop and generate data from dummy instruments
• Legacy features
  • Overview
  • Loop
    • Responsibilities:
    • Loops can fail:
  • Measure
  • DataSet
    • Responsibilities:
    • DataSets can fail:
• Measure without a Loop
  • Instantiates all the instruments needed for the demo
    • Only array output
• The Location Formatter
  • The formatter in action
• The Snapshot
  • Parameter snapshot
  • Instrument snapshot
  • Sweep snapshot
  • Loop/Measurement snapshot
• QCoDeS tutorial
  • Table of Contents
  • Typical QCodes workflow
    • Importing
    • Instantiation of instruments
    • The location provider can be set globally
  • Basic instrument interaction
  • Measuring
    • 1D Loop example
      • Defining the Loop and actions
      • Output of the loop
  • Loading data
  • Example: multiple 2D measurements with live plotting