feat/channelization: Add channels to instruments #568

spauka · 2017-04-11T05:35:21Z

Implements #273

This merge implements channelization in much the way that was discussed in #273, and commits two sample instruments that demonstrate the key features. Briefly, the syntax allows the creation of lists of channels within an instrument and manipulation of those channels. Examples of usage appear at the bottom of the commit.

Changes proposed in this pull request:

Add InstrumentChannel and ChannelList classes to hold channel classes. Addresses Instrument channels #273.
Create a driver for the Lakeshore Model336 Temperature controller that uses channels
Modify the driver for the Harvard DecaDAC to use channels. Fixes Decadac reset when restarting the kernel #478, bug: decadac getting and setting voltages fails unpredictably #546, Decadac doesn't get correct voltages on import #563.

For example:

>>> import qcodes as qc
>>> from Harvard.Decadac import Decadac
>>> d = Decadac("DAC", "ASRL4::INSTR")
Connected to Harvard DecaDAC (hw ver: 0, serial: 0) in 0.47s
>>> # Set a single channel
>>> d.channels[0].volt.set(-1)
>>> # Get a single channel
>>> d.channels.volt[0].get()
-1.00006103515625
>>> # Get multiple channels simultaneously
>>> d.channels.volt.get()
(1.00006103515625, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0)
>>> # Get a subset of channels
>>> d.channels[0:4].volt.get()
(-1.00006103515625, 0.0, 0.0, 0.0)
>>> # Combining different subsets is also possible
>>> fine = d.channels[0:2] + d.channels[4:6]
>>> fine.volt.get()
(-1.00006103515625, 0.0, 0.0, 0.0)
>>> # This also works with measure and loop
>>> qc.Measure(d.channels[0].volt).run()
DataSet:
   location = 'data/2017-04-11/#001_{name}_11-04-36'
   <Type>   | <array_id>           | <array.name> | <array.shape>
   Setpoint | single_set           | single       | (1,)
   Measured | DAC_Slot0_Chan0_volt | volt         | (1,)
acquired at 2017-04-11 11:04:36

Things left

Channel metadata is not correctly extracted from an instrument snapshot.
Test cases need to be written.

@giulioungaretti

* feat: Add a Keysight_34465A driver Add a first file for a driver for the Keysight 34465A DMM and a benchmarking notebook * Add trigger parameters to driver Add four trigger parameters to the driver. * refactor: Remove 'READ?' as volt get_cmd Make a more general get_cmd for the volt parameter. Using simply 'READ?' is wrong in many cases. * feat: Add sampling parameters Add four parameters for sampling. * fix: Fix wrong volt parameter get_cmd * WIP: Add Array parameter * feat: Add functioning data buffer parameter * Move notebook * Respond to review

Initial commit of two new classes to allow for channelization of instruments. This includes ChannelList, a container for channels in an instrument, and InstrumentChannel which implements a base class for an instance of a channel.

Add a driver for the Lakeshore Model 336 temperature controller using new channelization implementation.

Commits a channelized version of the Harvard DecaDAC driver using the new channelization implementation. Note that this driver at the present time also fixes a number of open bugs in the previous driver, including occasional crashes (microsoft#546), incorrectly reading DAC voltages (microsoft#563), reset (microsoft#478). This commit also adds a number of new features to the driver including: - Feature and version detection - Access to calibrated high-resolution mode of DAC - Parameter read from memory - Validation of writes

Fix bug in slicing/adding code, not correctly passing along channel list name.

- Removed useless methods - Whitespace

giulioungaretti · 2017-04-11T09:17:35Z

@spauka looking great. Did not check in super detail but ticks all the boxes!

I will tag @MerlinSmiles, since he had strong opinions about this as well!

MerlinSmiles · 2017-04-11T16:34:49Z

@spauka this looks really great! I haven't tested anything on this, but i'm really happy to see this.

What does the 0 in .get(0) do here: ?

>>> # Get a single channel
>>> d.channels.volt[0].get(0)

I have one point that I did not see covered. And that is access to the channels in another notation, (the slicing you show is great, but not the only useful way :)
I'm thinking of the following:
magnet.x.field.get()
The dac is a bit special and I see you split it in slots with 4 channels, that would then be:
d.slot1.ch0.volt.get()
I see a mismatch with the dac.channels you defined in the driver as this list is extended with all the channels. Not sure how to handle this.

One could of course make it on the driver level and define self.x = self.channels['x'] but if that is possible on one instrument I assume it should consistently be possible on many instruments.

Now im thinking of another syntax also:

d.volt.get()
>>>(1,0,0,0...)
```
would also be cool.
But maybe implemented on the driver level as parameters. But again consistency...

@giulioungaretti thanks for tagging, super excited :)

spauka · 2017-04-11T23:47:17Z

@MerlinSmiles For each of your points:

The 0 in .get(0) was a typo. Comments above edited.

Regarding different ways of addressing channels, agreed, there should be a way of having "named" channels. I suspect that the solution I am working on to store channel metadata will solve this, new commits coming soon.

However, I think it also makes sense to keep separate the idea of named and numbered channels, i.e. addressing the DAC as dac.chan0 makes less sense than magnet.x.

For the last syntax d.volt.get(), sounds good, but it doesn't necessarily make sense to break all channel parameters out in this way. Perhaps we can explicitly define such parameters in the instrument?

Anyway, let me know whether the below commits address your points...

MerlinSmiles · 2017-04-12T07:22:24Z

@spauka totally agree with you!

jenshnielsen · 2017-04-24T14:21:02Z

qcodes/instrument/channel.py

+
+        self._parent = parent
+        self._name = name
+        if not isinstance(chan_type, type) != type or not issubclass(chan_type, InstrumentChannel):


As far as I can see the first part of this condition will always be True?

not isinstance(chan_type, type) != type -> not bool != type -> not False.

Yep, that's true. Fixed in a future commit :)

jenshnielsen · 2017-05-16T07:41:12Z

@spauka What's the status of this. It would be great to have it land soon. It's a much requested feature. I pointed out a small issue above and there is a conflict in the decadac driver now since we merged #552

jenshnielsen · 2017-05-16T07:47:58Z

I'm happy to help writing some of the tests of anything else if you don't have the time

spauka · 2017-05-30T06:19:38Z

@jenshnielsen sorry, got a bit distracted by other projects for the last few weeks but am currently doing work on implementing snapshotting. Any help you can give on tests would be much appreciated.

Allows certain channel lists to be excluded from snapshots. This is helpful when, for example, there are multiple ways to access the same channel.

This feature is implemented by creating the idea of a submodule in the instrument class. This is just a class which implements the Instrument class, and may be a channel list or may just implement a logical collection of parameters within a parent instrument. For example, looking at the Lakeshore Model_336 driver, each channel can either be accessed as a member of a channel list, or by using the name of the channel: ```python3 therm = Model_336("therm", "...") # These two accesses are equivalent therm.A.temperature() therm.channels[0].temperature() ```

spauka · 2017-05-30T08:01:46Z

Channel lists should now be snapshotable. This is implemented by creating the concept of a submodule in an instrument, where a submodule is just a class that implements the Instrument class.

A side effect of this is that it is now also possible to create sub-instruments, which may be logical groupings of parameters, inside instruments.

To see an example of this, see the Lakeshore.Model_336 driver, wherein temperature channels may be accessed in two ways:

therm = Model_336("therm", "...")
# The below two lines access the same parameter
therm.A.temperature()
therm.channels[0].temperature()
# The next statement evaluates to true
therm.A == therm.channels[0]

Should think about the best way to implement this change.

jenshnielsen · 2017-05-30T11:26:36Z

@spauka Great I will start working on some tests

jenshnielsen · 2017-05-30T12:23:26Z

qcodes/instrument_drivers/Lakeshore/Model_336.py

+			channels.append(channel)
+			self.add_submodule(chan_name, channel)
+		channels.lock()
+		self.add_submodule("channels", channels)


This fails for me with TypeError: Submodules must be subclasses of instrument. I guess the check in add_submodule should be a bit more permissive?

Yes, you are correct, submodules need to be subclasses of Metadatable, Instrument is too restrictive. This is fixed in 4a3e517

Submodule objects must be Metadatables at minimum, instrument is too restrictive for channels.

And error clearly if you try to measure multiple multiparameters

jenshnielsen · 2017-06-07T15:41:33Z

Work in progress support for slicing Array parameters and tests are in https://github.com/jenshnielsen/Qcodes/tree/feat/channelization_with_array

Seems to work good but names are currently incorrect for array and multi parameters saved to dataset via loop. (missing channel prefix in names i.e. this and that instead of ChanA_this and ChanA_that and so on

This reverts commit 2dbacc0.

jenshnielsen · 2017-06-08T11:50:35Z

I pushed some changes to spauka#2 adding support for ArrayParameters

jenshnielsen · 2017-06-08T11:51:01Z

@WilliamHPNielsen is experimenting on porting the QDac driver

Add a QDac driver using the new channelisation feature

…array Feat/channelization with array

WilliamHPNielsen · 2017-06-09T15:00:20Z

I added three commits to @jenshnielsen's PR that:

Add a channelised QDac driver
Add a set method to MultiChannelInstrumentParameter
Add a notebook for the channelised QDac

I learned that it could be very de-confusing for some instrument drivers if the channel list could be optionally 1-indexed.

Make the paramclass returned by __getattr__ be customisable.

Add a channelised driver for the QDac. This requires changing the base code for channels a bit to allow for custom MultiChannelInstrumentParameter subclasses.

…array Driver/QDac_channels

WilliamHPNielsen · 2017-06-14T09:46:12Z

The QDac driver now contains its own subclass of MultiChannelInstrumentParameter and a change to channels.py that allows for this to happen.

@spauka I think we should merge soon, did you have a chance to look at the Decadac driver?

WilliamHPNielsen · 2017-06-15T13:09:00Z

PEP8 would be nice, but I think we can merge now. @jenshnielsen ?

jenshnielsen · 2017-06-15T13:13:02Z

Yes It would be nice to have spauka#2 merged into this before merging I think

spauka · 2017-06-15T13:59:43Z

I will merge spauka#2 tomorrow (Sydney time) if that's ok with you all, but I agree with above, let's lock features here and deal with new additions in future pull requests.

…

On Thu., 15 Jun. 2017, 11:56 pm Jens Hedegaard Nielsen, < ***@***.***> wrote: Yes It would be nice to have spauka#2 <spauka#2> merged into this before merging I think — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#568 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAmyvAc_SlfuiEmHh6Ksp9C37UB3DV-Xks5sES3fgaJpZM4M5o7H> .

Add support for array parameters to MultiChannelInstrumentParameter

jenshnielsen · 2017-06-16T09:06:24Z

Landed via #640 Thank you very much @spauka

WilliamHPNielsen and others added 8 commits April 11, 2017 10:19

feat: Add channelization

fda0f8d

Initial commit of two new classes to allow for channelization of instruments. This includes ChannelList, a container for channels in an instrument, and InstrumentChannel which implements a base class for an instance of a channel.

feat: Add channelized Lakeshore Model336 Driver

863fa19

Add a driver for the Lakeshore Model 336 temperature controller using new channelization implementation.

Merge branch 'master' into feat/channelization

5827028

fix: bug in slicing and adding code

76af2a3

Fix bug in slicing/adding code, not correctly passing along channel list name.

style: fix formatting and make codacy fixes

4f36e59

style: fix more code style issues

a793819

- Removed useless methods - Whitespace

jenshnielsen reviewed Apr 24, 2017

View reviewed changes

nataliejpg mentioned this pull request Apr 26, 2017

fix: Respond to issue #546 #552

Merged

Merge remote-tracking branch 'refs/remotes/QCoDeS/master'

db446e7

spauka added 4 commits May 30, 2017 16:26

fix: flush is now handled correctly in instrument base class

5e1d23e

feat: Allow channellists to be excluded from snapshots

4ed3f4e

Allows certain channel lists to be excluded from snapshots. This is helpful when, for example, there are multiple ways to access the same channel.

Merge branch 'master' into feat/channelization

857e881

spauka added 3 commits May 30, 2017 18:03

style: remove force arg in snapshot_base

e5cda8b

Should think about the best way to implement this change.

style: remove unessecary import

f4172d2

fix: error in type check.

3aabf27

jenshnielsen reviewed May 30, 2017

View reviewed changes

spauka and others added 2 commits May 30, 2017 22:33

fix: submodules should be Metadatable

4a3e517

Submodule objects must be Metadatables at minimum, instrument is too restrictive for channels.

Start adding tests for channels

703cc84

Add support to array parameters in channels

4770840

And error clearly if you try to measure multiple multiparameters

jenshnielsen added 3 commits June 8, 2017 13:10

Mock parameters add instruments to fix names in tests

4b051cb

refactor tests to reduce code duplication

6d11b5b

Revert "Add some channel notebooks"

e1c6a57

This reverts commit 2dbacc0.

WilliamHPNielsen and others added 4 commits June 9, 2017 16:48

feat: Add channelised QDac driver

f05a970

Add a QDac driver using the new channelisation feature

feat: Add a set method to MultiChannelInstrumentParameter

e80de66

docs: Add a driver example for the channelised Qdac

c90ac7c

Merge pull request #2 from WilliamHPNielsen/feat/channelization_with_…

c497e65

…array Feat/channelization with array

WilliamHPNielsen and others added 5 commits June 12, 2017 13:32

feat: Make ChannelList take default paramclass

1793d19

Make the paramclass returned by __getattr__ be customisable.

feat: Add a channelised QDac driver

a4e4b90

Add a channelised driver for the QDac. This requires changing the base code for channels a bit to allow for custom MultiChannelInstrumentParameter subclasses.

docs: Add notebook for QDac w. channels

034fbf5

style: Remove unnecessary comment

83a32e8

Merge pull request #3 from WilliamHPNielsen/feat/channelization_with_…

eb5e700

…array Driver/QDac_channels

jenshnielsen mentioned this pull request Jun 14, 2017

Znb 20 fixes as requested by t10 #623

Closed

7 tasks

Fix syntax/spelling errors in DAC driver

2dcc932

jenshnielsen added 3 commits June 15, 2017 15:31

Fix: qdac_channels remove magic number

84b663b

Doc: clarify doc string

8a44cd4

Fix: rename paramclass to be more specific

24f65a2

Merge pull request #2 from jenshnielsen/feat/channelization_with_array

3145c52

Add support for array parameters to MultiChannelInstrumentParameter

jenshnielsen mentioned this pull request Jun 16, 2017

Feat/channelization with small cleanup #640

Merged

jenshnielsen closed this Jun 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat/channelization: Add channels to instruments #568

feat/channelization: Add channels to instruments #568

spauka commented Apr 11, 2017 •

edited

Loading

giulioungaretti commented Apr 11, 2017

MerlinSmiles commented Apr 11, 2017

spauka commented Apr 11, 2017 •

edited

Loading

MerlinSmiles commented Apr 12, 2017

jenshnielsen Apr 24, 2017

spauka May 30, 2017

jenshnielsen commented May 16, 2017

jenshnielsen commented May 16, 2017

spauka commented May 30, 2017

spauka commented May 30, 2017

jenshnielsen commented May 30, 2017

jenshnielsen May 30, 2017

spauka May 30, 2017

jenshnielsen commented Jun 7, 2017

jenshnielsen commented Jun 8, 2017

jenshnielsen commented Jun 8, 2017

WilliamHPNielsen commented Jun 9, 2017 •

edited

Loading

WilliamHPNielsen commented Jun 14, 2017

WilliamHPNielsen commented Jun 15, 2017

jenshnielsen commented Jun 15, 2017

spauka commented Jun 15, 2017 via email

jenshnielsen commented Jun 16, 2017

feat/channelization: Add channels to instruments #568

feat/channelization: Add channels to instruments #568

Conversation

spauka commented Apr 11, 2017 • edited Loading

giulioungaretti commented Apr 11, 2017

MerlinSmiles commented Apr 11, 2017

spauka commented Apr 11, 2017 • edited Loading

MerlinSmiles commented Apr 12, 2017

jenshnielsen Apr 24, 2017

Choose a reason for hiding this comment

spauka May 30, 2017

Choose a reason for hiding this comment

jenshnielsen commented May 16, 2017

jenshnielsen commented May 16, 2017

spauka commented May 30, 2017

spauka commented May 30, 2017

jenshnielsen commented May 30, 2017

jenshnielsen May 30, 2017

Choose a reason for hiding this comment

spauka May 30, 2017

Choose a reason for hiding this comment

jenshnielsen commented Jun 7, 2017

jenshnielsen commented Jun 8, 2017

jenshnielsen commented Jun 8, 2017

WilliamHPNielsen commented Jun 9, 2017 • edited Loading

WilliamHPNielsen commented Jun 14, 2017

WilliamHPNielsen commented Jun 15, 2017

jenshnielsen commented Jun 15, 2017

spauka commented Jun 15, 2017 via email

jenshnielsen commented Jun 16, 2017

spauka commented Apr 11, 2017 •

edited

Loading

spauka commented Apr 11, 2017 •

edited

Loading

WilliamHPNielsen commented Jun 9, 2017 •

edited

Loading