The Location Formatter

The Location Formatter controls the format of the location to which data are saved.

This notebook shows some examples of setting different location formats.

%matplotlib nbagg
import time

import matplotlib.pyplot as plt
import numpy as np
from qcodes.station import Station

from qcodes_loop.data.location import FormatLocation
from qcodes_loop.loops import Loop

Logging hadn't been started.
Activating auto-logging. Current session state plus future input saved.
Filename       : C:\Users\a-halakh\.qcodes\logs\command_history.log
Mode           : append
Output logging : True
Raw input log  : False
Timestamping   : True
State          : active
Qcodes Logfile : C:\Users\a-halakh\.qcodes\logs\200325-3652-qcodes.log

# First we set up some mock experiment
from qcodes.instrument_drivers.mock_instruments import DummyInstrument

gates = DummyInstrument('some_gates', gates=['plunger', 'left', 'topo'])
meter = DummyInstrument('meter', gates=['voltage', 'current'])

station = Station(gates, meter)

The formatter in action

Now let’s run some loops to get datasets and see where they end up.

When writing the location format, some fields are automatically filled out.

That is the fields ‘{date}’, ‘{time}’, and ‘{counter}’. All other fields must have their values provided via the record dict.

loc_fmt='{date}/#{counter}_{name}_{date}_{time}'  # set the desired location format
rcd={'name': 'unicorn'}  # provide a value for 'name'
loc_provider = FormatLocation(fmt=loc_fmt, record=rcd)  # create a location provider using that format

loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)
data2 = loop.run(location=loc_provider)

Started at 2020-03-25 11:51:27
DataSet:
   location = '2020-03-25/#003_unicorn_2020-03-25_11-51-27'
   <Type>   | <array_id>             | <array.name> | <array.shape>
   Setpoint | some_gates_plunger_set | plunger      | (25,)
   Measured | meter_voltage          | voltage      | (25,)
Finished at 2020-03-25 11:51:27

# Now let's do that a few times with different formats

import numpy as np

loc_fmt='my_custom_folder/#{counter}_randomnumber_{name}_{date}_{time}'
rcd = {'name': str(np.random.randint(1, 100))}
loc_provider = FormatLocation(fmt=loc_fmt, record=rcd)

loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)
data2 = loop.run(location=loc_provider)

Started at 2020-03-25 11:51:27
DataSet:
   location = 'my_custom_folder/#004_randomnumber_7_2020-03-25_11-51-27'
   <Type>   | <array_id>             | <array.name> | <array.shape>
   Setpoint | some_gates_plunger_set | plunger      | (25,)
   Measured | meter_voltage          | voltage      | (25,)
Finished at 2020-03-25 11:51:27

# You can also overwrite the custom fields

loc_fmt='{date}/#{counter}_{name}_{date}_{time}'
rcd = {'time': 'hammer_time'}
loc_provider = FormatLocation(fmt=loc_fmt, record=rcd)

loop = Loop(gates.plunger.sweep(0, 1, num=25), 0).each(meter.voltage)
data2 = loop.run(location=loc_provider)

Started at 2020-03-25 11:51:27
DataSet:
   location = '2020-03-25/#004_{name}_2020-03-25_hammer_time'
   <Type>   | <array_id>             | <array.name> | <array.shape>
   Setpoint | some_gates_plunger_set | plunger      | (25,)
   Measured | meter_voltage          | voltage      | (25,)
Finished at 2020-03-25 11:51:28