StationConfigurator #68

Dominik-Vogel · 2018-03-02T17:48:01Z

In this PR a StationConfigurator object is introduced, which enables loading instrument through a yaml file. An example code could look like this:

from qdev_wrappers.station_configurator import StationConfigurator


scfg = StationConfigurator('exampleConfig.yaml')
dmm1 = scfg.load_instrument('dmm1')
mock_dac = scfg.load_instrument('mock_dac')

With a yaml file containing:

instruments:
  dmm1:
    driver: qcodes.instrument_drivers.agilent.Agilent_34400A
    type: Agilent_34400A
    auto_reconnect: true
    address: GPIB::1::65535::INSTR
    init:
      visalib: 'Agilent_34400A.yaml@sim'
    parameters:
      volt: {monitor: true}
  mock_dac:
    driver: qcodes.tests.instrument_mocks
    type: DummyInstrument
    auto_reconnect: true
    init:
      gates: {"ch1", "ch2"}

For the complete example and an extensive commented yaml file take a look at the example in the example folder. For a full list of features refer to the yaml file.
This PR depends on microsoft/Qcodes#986

Current issues:

jenshnielsen · 2018-03-08T15:05:15Z

qdev_wrappers/station_configurator.py

@@ -155,14 +147,12 @@ def setup_parameter_from_dict(p, options):

        # add the instrument to the station
        self.station.add_component(instr)
+
+        # restart the monitor to apply the changes


Is this restart really needed anymore? Creating a new monitor should do the job?

jenshnielsen · 2018-03-15T09:18:15Z

Need microsoft/Qcodes#994 and microsoft/Qcodes#986

There is a experiments.db file committed that should probably be deleted

jenshnielsen · 2018-03-14T14:19:13Z

qdev_wrappers/station_configurator.py

+
+    def __init__(self, filename: str, station: Optional[Station] = None) -> None:
+        self.monitor_parameters = {}
+        # self.station = station if is not None else Station.default if is not None else Station()


remove the line above

jenshnielsen · 2018-03-15T08:47:41Z

qdev_wrappers/station_configurator.py

+            def snapshot(self, update=True):
+                return self.data
+
+        # self.station.add_component(ConfigComponent(self.config), 'Config')


jenshnielsen · 2018-03-15T08:51:13Z

qdev_wrappers/station_configurator.py

+
+        # local function to refactor common code from defining new parameter
+        # and setting existing one
+        def setup_parameter_from_dict(p, options):


could use a better variable name that p. Typing would be nice too

jenshnielsen · 2018-03-19T14:38:16Z

qdev_wrappers/station_configurator.py

+# config from the qcodesrc.json file (working directory, home or qcodes dir)
+auto_reconnect_instrument = qcodes.config["user"]["auto_reconnect_instrument"]
+
+


Should the atexit register logic be added to the station Configurator? Since it creates the instruments I think so

I would rather prefer not to. The way it is now the StationConfigurator is an optional component, that you can use if you like it. The atexit should not be optional. But I have to say that I don't have a better idea where to put it.
What about the init of qdev wrappers. It might get added multiple times then but this should not break anything. Now that we are excluding packages from the UMR this should work, right?

Yes running it multiple times should be fine. We still need to merge microsoft/Qcodes#1009 to fix the UMR issue

…etup Feat/station configurator add (partial) YML file for test setup

…dev-wrappers into feat/StationConfigurator

jenshnielsen · 2018-04-04T10:43:49Z

@Dominik-Vogel Could you update the example yml for the test setup to the new style too

jenshnielsen · 2018-04-05T08:14:05Z

@Dominik-Vogel Somehow a non standard char ended up on the last line of the testsetup config. Confusing git and pyyaml. I have pushed a fix to remove that

ThorvaldLarsen · 2018-04-08T10:38:03Z

@Dominik-Vogel can we call force_close_existing_instrument for enable_forced_reconnect? Having 'enable' in the name emphasizes that the setting allows you to reconnect instruments not that the code does anything on its own.

Dominik-Vogel · 2018-04-09T09:04:04Z

@jenshnielsen Had I missed anything in the example yaml for the test setup? What do you want me to update?

ThorvaldLarsen · 2018-04-09T17:47:59Z

qdev_wrappers/station_configurator.py

+                self.monitor_parameters = {k:v for k,v in self.monitor_parameters.items() if v.root_instrument is not instr}
+                instr.close()
+                # remove instrument from station snapshot
+                self.station.components.pop(instr.name)


If understand this correctly then if enable_forced_reconnect is false then the configure instead creates a new instrument in the station.
Is this the behavior we want? I initially assumed the configure would throw an error message and do nothing if enable_forced_reconnect is false. Maybe we can add a warning message printed to the console to notify the user that a new instrument instance is created?

I think it's going to fail earlier because it's trying to create a new instrument with the same name

It's good to see that you already got so much used to the StationConfigurator, that you forgot how it was like before ;-). When you try to create the instrument again, you will get an error from qcodes saying that you can't create an instrument with the same name.

the comments crossed...

Ahh, I see. Thanks.

jenshnielsen · 2018-04-10T07:03:04Z

setup.py

@@ -20,7 +20,8 @@
    install_requires=[
        'matplotlib>=2.0.2',
        'pyqtgraph>=0.10.0',
-        'qcodes>=0.1.3'
+        'qcodes>=0.1.3',


This should probably be bumped to the latest release?

ThorvaldLarsen · 2018-04-10T07:42:37Z

One more request: Would it be possible to add Offset to the list of PARAMETER_ATTRIBUTES. I have a specific instrument that really could benefit from this.

I realise that this is probably more a question for parameter class in core qcodes but if it is not too hard to add I think it would be a nice feature. This would allow the user to easily adjust for calibration errors on instruments (like a constant voltage offset that is often seen on decadacs),

Dominik-Vogel · 2018-04-10T08:42:25Z

You are totally right, and this is already on my list of things to implement.

ThorvaldLarsen · 2018-04-12T13:39:20Z

@Dominik-Vogel can you add a function for updating the monitor? That is running .get() on all parameters in the monitor list.
Right now I am doing:
for i in scfg.monitor_parameters: scfg.monitor_parameters[i].get(); but it is a bit confusing figuring out that this works.
Would be nice to just write something like scfg.monitor_update() which everyone can understand.

Dominik-Vogel · 2018-04-16T07:21:30Z

sure :-)

ThorvaldLarsen · 2018-04-17T08:20:03Z

@Dominik-Vogel maybe we can merge this one and then add extra functionality in future PR's?

Dominik-Vogel added 5 commits March 2, 2018 18:40

initial commit

316abce

make parameters only appear once in monitor

561c9e4

fixed example

13b66a5

fixing metadata copies of station config

4dcd5ad

bugfixes

9cc9f75

jenshnielsen reviewed Mar 8, 2018

View reviewed changes

jenshnielsen requested changes Mar 15, 2018

View reviewed changes

Dominik-Vogel force-pushed the feat/StationConfigurator branch from d95450d to 9cc9f75 Compare March 15, 2018 15:38

Dominik-Vogel added 5 commits March 15, 2018 16:59

changed root instrument to property

cebf548

removed comments, better argument names

ba56595

renamed example file

ab41d1e

missed line

7fcfa65

Added Parameter class to wrap get and set

9aa636c

jenshnielsen reviewed Mar 19, 2018

View reviewed changes

Dominik-Vogel and others added 13 commits March 20, 2018 13:25

added pyyaml to dependencies

933ae3e

Add (partial) yaml config for test setup

29f073b

update testsetup yaml file

958090e

add awg

e24c976

add new 5208 awg

90876b2

Merge pull request #1 from jenshnielsen/feat/StationConfiguratorTestS…

a8692e3

…etup Feat/station configurator add (partial) YML file for test setup

removed experiments.db

ad75bbd

Merge branch 'feat/StationConfigurator' of github.com:Dominik-Vogel/q…

f3059fb

…dev-wrappers into feat/StationConfigurator

passsing kwargs on to instrument init

6234b1d

renamed auto_reconnect to force_close_existing_instrument

8e90504

renamed value to initial_value

ae1e2a1

renamed new_parameters to add_parameters

06b45b1

removing instruments from snapshot when reinitialized

939a41c

remove special char

fa80e97

renamed to option to enable_forced_reconnect

ae5db3e

ThorvaldLarsen reviewed Apr 9, 2018

View reviewed changes

jenshnielsen reviewed Apr 10, 2018

View reviewed changes

bumped up qcodes version

3e95d79

added default directory

e994f7a

quick fix for failing dict update

d0e5ff8

jenshnielsen approved these changes Apr 16, 2018

View reviewed changes

jenshnielsen merged commit 370b9f6 into qdev-dk:master Apr 17, 2018

Dominik-Vogel mentioned this pull request Sep 3, 2018

StationConfigurator microsoft/Qcodes#1256

Closed

Dominik-Vogel mentioned this pull request May 13, 2019

Extend QCoDeS-Station to be configurable through yaml file microsoft/Qcodes#1560

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

StationConfigurator #68

StationConfigurator #68

Dominik-Vogel commented Mar 2, 2018 •

edited

Loading

jenshnielsen Mar 8, 2018

jenshnielsen commented Mar 15, 2018

jenshnielsen Mar 14, 2018

jenshnielsen Mar 15, 2018

jenshnielsen Mar 15, 2018

jenshnielsen Mar 19, 2018

Dominik-Vogel Mar 20, 2018

jenshnielsen Mar 20, 2018

jenshnielsen commented Apr 4, 2018

jenshnielsen commented Apr 5, 2018

ThorvaldLarsen commented Apr 8, 2018

Dominik-Vogel commented Apr 9, 2018

ThorvaldLarsen Apr 9, 2018

jenshnielsen Apr 10, 2018

Dominik-Vogel Apr 10, 2018

Dominik-Vogel Apr 10, 2018

ThorvaldLarsen Apr 10, 2018

jenshnielsen Apr 10, 2018

ThorvaldLarsen commented Apr 10, 2018

Dominik-Vogel commented Apr 10, 2018

ThorvaldLarsen commented Apr 12, 2018

Dominik-Vogel commented Apr 16, 2018

ThorvaldLarsen commented Apr 17, 2018

		# config from the qcodesrc.json file (working directory, home or qcodes dir)
		auto_reconnect_instrument = qcodes.config["user"]["auto_reconnect_instrument"]

StationConfigurator #68

StationConfigurator #68

Conversation

Dominik-Vogel commented Mar 2, 2018 • edited Loading

Current issues:

Choose a reason for hiding this comment

jenshnielsen commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenshnielsen commented Apr 4, 2018

jenshnielsen commented Apr 5, 2018

ThorvaldLarsen commented Apr 8, 2018

Dominik-Vogel commented Apr 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThorvaldLarsen commented Apr 10, 2018

Dominik-Vogel commented Apr 10, 2018

ThorvaldLarsen commented Apr 12, 2018

Dominik-Vogel commented Apr 16, 2018

ThorvaldLarsen commented Apr 17, 2018

Dominik-Vogel commented Mar 2, 2018 •

edited

Loading