Driver dev/switch matrix #1373

StefanD986 · 2018-11-05T14:57:29Z

Adds driver and example notebook for Keysight B2200 Femto leakage switch Matrix

Changes proposed in this pull request:

Example Notebook under docs/examples/driver_examples/Qcodes_example_with_Keysight_B2200_femto_leakage_switch_matrix.ipynb
Driver under qcodes/instrument_drivers/Keysight/keysight_b220x.py
Tests under qcodes/tests/drivers/test_keysight_b220x.py

@astafan8

…real instrument.

…strument.

…tead of disconnect). This adds a test for the issue and fixes the problem.

…nction

…t clearer what the function does

… as a getter.

qcodes/instrument_drivers/Keysight/keysight_b220x.py

sohailc · 2018-11-05T18:14:29Z

Great work, @StefanD986! I would suggest:

Add type hints
Check that some lines of code are not overly long. I think the standard is 80 characters.

jenshnielsen · 2018-11-06T08:32:52Z

@StefanD986 Thanks for the contribution. There is a few small things you need to do to get the docs to build correctly. For this to work there are some requirements for the structure of the notebook. Please ensure that the notebook starts with a single level 1 heading (A single #) with the title of the notebook. All other titles should be level 2 (##) or 3 (###) taking care that level 3 headings only appear within level2 headings. Could you also rename the notebook file so that it is consistent with the other ones in https://github.com/QCoDeS/Qcodes/tree/master/docs/examples/driver_examples

...xamples/driver_examples/Qcodes_example_with_Keysight_B2200_femto_leakage_switch_matrix.ipynb

qcodes/instrument_drivers/Keysight/keysight_b220x.py

astafan8

That is a well-written driver, and an outstanding example notebook! Thank you for the quality! Users will be very happy!

I request changes in order to get the usage of add_function removed, get pep8 lines length, and get typos fixed.

qcodes/instrument_drivers/Keysight/keysight_b220x.py

qcodes/tests/drivers/test_keysight_b220x.py

qcodes/instrument_drivers/Keysight/keysight_b220x.py

changes in this commit: - Wrong termination character was used. - in several places unclarities in the documentation/notebook were (hopefully) cleared up - deprecated usage of `add_function` was replaced with normal python methods. - at some places type hints were added. - in all commands the previously hardcoded `card` parameter was replaced with the private self._card. This is currently not used but will make it easier to add future functionality. - several other small changes as requested in discussion of PR

… made changes

… Matrix.ipynb Changes heading levels in example notebook

status polling is added by using a decorator around the function calls. This is now only used for member functions, not for properties!

mypy doesn't seem like decorated functions. For now I simply removed the typehints, and added some docstrings instead.

…86/Qcodes into driver_dev/SwitchMatrix

Stack level of warning is changed to 2, so that the line of code which caused the warning is displayed in the warning, instead of reporting the line of code in the function which is used to check the status byte and issue the warning.

…iver_dev/SwitchMatrix

… without errors

codecov · 2018-11-22T12:30:06Z

Codecov Report

Merging #1373 into master will increase coverage by 0.25%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1373      +/-   ##
==========================================
+ Coverage   73.52%   73.78%   +0.25%     
==========================================
  Files          79       80       +1     
  Lines        9267     9345      +78     
==========================================
+ Hits         6814     6895      +81     
+ Misses       2453     2450       -3

astafan8

Modulo minor comments, i think it's ready!

qcodes/instrument_drivers/Keysight/keysight_b220x.py

qcodes/tests/drivers/test_keysight_b220x.py

@astafan8

To please humans and machines alike this - removes 1 unused import - replaces str.format syntax with python 3.6 f-strings (thanks @astafan8 for the hint) - some other small changes to please the linter

astafan8

I think this is ready to go. Last chance to confirm: does the driver work OK for the real instrument? :) if yes, then i'll merge.

StefanD986 · 2018-11-23T15:08:13Z

Didn’t see any smoke. Go ahead.

Merge: 6d7cca6 48ea426 Author: Mikhail Astafev <astafan8@gmail.com> Merge pull request #1373 from StefanD986/driver_dev/SwitchMatrix

StefanD986 added 20 commits October 18, 2018 16:55

adds (Work-in-Progress) Keysight B2200A switch matrix driver

136245b

start over with some basic driver functions

7f8cdfe

fixes bias enable/disable command should use channel 0 in Auto mode

d5bf6cb

adds more driver functions and enables (optionally) testing with the …

f63ba45

…real instrument.

fixes a couple of discrepancies between the simulated and the real in…

bc637e8

…strument.

Adds test for `connection_sequence

e5429cf

Adds tests for connect, disconnect and disconnect_all methods

4d37baf

in the disconnect function the wrong function was called (connect ins…

0c6c69d

…tead of disconnect). This adds a test for the issue and fixes the problem.

Renames two methods related to the ground mode

f2c4b94

Decided to only allow lists in gnd_enabled_inputs and couple_ports fu…

f10ce43

…nction

renames more methods

f2dbe45

reverts a change that was accidentally cmmited earlier

28c7c08

Adds couple mode ON/OFF function

bab38b9

Reverts accidentally commited hunk from f2c4b94

cda32a4

Adds method to read and parse active connections from switch matrix

9d350cd

Adds notebook with examples for Keysight B2200 switch matrix

5d40860

rename gnd_enabled_inputs to set_unused_inputs in order to make i…

4866694

…t clearer what the function does

removes set prefix from set_unused_inputs because it is also used…

b805d5a

… as a getter.

updates keysight b2200 example notebook

ea06277

Adds some docstrings to the functions

20d3d36

sohailc reviewed Nov 5, 2018

View reviewed changes

qcodes/instrument_drivers/Keysight/keysight_b220x.py Outdated Show resolved Hide resolved

jenshnielsen reviewed Nov 6, 2018

View reviewed changes

...xamples/driver_examples/Qcodes_example_with_Keysight_B2200_femto_leakage_switch_matrix.ipynb Outdated Show resolved Hide resolved

jenshnielsen reviewed Nov 6, 2018

View reviewed changes

qcodes/instrument_drivers/Keysight/keysight_b220x.py Outdated Show resolved Hide resolved

astafan8 requested changes Nov 7, 2018

View reviewed changes

astafan8 and others added 4 commits November 7, 2018 11:51

Merge branch 'master' into driver_dev/SwitchMatrix

7ba24a0

Updates Notebook cell outputs from physical instrument after recently…

c356d9a

… made changes

Update Qcodes example with Keysight B2200 Series Femto Leakage Switch…

26376f9

… Matrix.ipynb Changes heading levels in example notebook

StefanD986 and others added 8 commits November 21, 2018 17:37

adds status polling for instrument functions

eccae46

status polling is added by using a decorator around the function calls. This is now only used for member functions, not for properties!

Merge branch 'master' into driver_dev/SwitchMatrix

3a150ba

Removes typehints from decorated functions

7cbee78

mypy doesn't seem like decorated functions. For now I simply removed the typehints, and added some docstrings instead.

Merge branch 'driver_dev/SwitchMatrix' of https://github.com/StefanD9…

8dac78b

…86/Qcodes into driver_dev/SwitchMatrix

changes stacklevel of warning

60a792c

Stack level of warning is changed to 2, so that the line of code which caused the warning is displayed in the warning, instead of reporting the line of code in the function which is used to check the status byte and issue the warning.

Updates example notebook with latest changes.

f16ccb6

Merge remote-tracking branch 'origin/driver_dev/SwitchMatrix' into dr…

2eb3962

…iver_dev/SwitchMatrix

fixes heading levels in example notebook so that documentation builds…

b4eda67

… without errors

Merge branch 'master' into driver_dev/SwitchMatrix

3efeca6

astafan8 approved these changes Nov 22, 2018

View reviewed changes

qcodes/instrument_drivers/Keysight/keysight_b220x.py Show resolved Hide resolved

qcodes/instrument_drivers/Keysight/keysight_b220x.py Show resolved Hide resolved

qcodes/tests/drivers/test_keysight_b220x.py Show resolved Hide resolved

Code beautifications

48ea426

To please humans and machines alike this - removes 1 unused import - replaces str.format syntax with python 3.6 f-strings (thanks @astafan8 for the hint) - some other small changes to please the linter

astafan8 approved these changes Nov 23, 2018

View reviewed changes

astafan8 merged commit c195dc8 into microsoft:master Nov 24, 2018

giulioungaretti pushed a commit that referenced this pull request Nov 24, 2018

Generated gh-pages for commit c195dc8

03f73ef

Merge: 6d7cca6 48ea426 Author: Mikhail Astafev <astafan8@gmail.com> Merge pull request #1373 from StefanD986/driver_dev/SwitchMatrix

StefanD986 deleted the driver_dev/SwitchMatrix branch November 25, 2018 09:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Driver dev/switch matrix #1373

Driver dev/switch matrix #1373

StefanD986 commented Nov 5, 2018

sohailc commented Nov 5, 2018

jenshnielsen commented Nov 6, 2018

astafan8 left a comment

codecov bot commented Nov 22, 2018 •

edited

astafan8 left a comment

astafan8 left a comment

StefanD986 commented Nov 23, 2018

Driver dev/switch matrix #1373

Driver dev/switch matrix #1373

Conversation

StefanD986 commented Nov 5, 2018

sohailc commented Nov 5, 2018

jenshnielsen commented Nov 6, 2018

astafan8 left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 22, 2018 • edited

Codecov Report

astafan8 left a comment

Choose a reason for hiding this comment

astafan8 left a comment

Choose a reason for hiding this comment

StefanD986 commented Nov 23, 2018

codecov bot commented Nov 22, 2018 •

edited