Add a bunch of new drivers #261

thangleiter · 2023-10-18T12:51:00Z

I am finally tackling our driver backlog. Some of these are likely to be of limited broad appeal, so let me know if adding them is out of scope for the main repo.

If desired I can split up the PR into one for each new driver.

Possible extensions: - parse LabSpec6 config file to determine which motor sits at which address on the board to avoid having to manually set the IDs etc. at runtime. - otherwise, use a simple Python data structure to do the same.

In case someone wants to implement a newer version of the dll in the future.

# Conflicts: # qcodes_contrib_drivers/drivers/msquared/__init__.py # qcodes_contrib_drivers/drivers/msquared/solstis_3.py

include verbose parameters if one wants to display the JSON strings

functions to get/set lock create parameters wavelength_t/wavelength_m and lock

docs/examples/Horiba_FHR.ipynb

astafan8 · 2023-10-18T12:59:49Z

also a few typing errors to fix, see here https://github.com/QCoDeS/Qcodes_contrib_drivers/actions/runs/6561129954/job/17820255378?pr=261

astafan8 · 2023-10-18T12:59:56Z

thanks for the contribution!

thangleiter · 2023-10-18T15:56:49Z

also a few typing errors to fix, see here https://github.com/QCoDeS/Qcodes_contrib_drivers/actions/runs/6561129954/job/17820255378?pr=261

I'd appreciate if you could help me out with some of those since I don't have a lot of experience with mypy.

The first one looks to me like it's unavoidable if msl-loadlib is not added to the requirements, which I'm not sure we want.
This and the two following ones seems like ctypes.byref doesn't accept TypeVars? I can't come up with another solution than to drop the hint altogether.
The stubs for tqdm are not installed. Is there another way around this?
Stacking classmethod and property decorators apparently has been deprecated in Python. Any suggestions for how instead to enforce an abstract attribute that subclasses need to implement? I also used this in Thorlabs kinesis drivers #262 :)

astafan8 · 2023-10-19T07:26:05Z

msl.loadlib you can add to pyproject.toml to tool.mypy.overrides section here

Qcodes_contrib_drivers/pyproject.toml

Lines 66 to 78 in 3c10e07

    
           module = [ 
        
               "cffi", 
        
               "keysightSD1", 
        
               "nidaqmx.*", 
        
               "niswitch.*", 
        
               "pandas", 
        
               "py_header.*", 
        
               "pyspcm", 
        
               "spirack", 
        
               "zhinst.*", 
        
               "ruamel.*" 
        
           ] 
        
           ignore_missing_imports = true

types-tqdm>=4.64.6 can be added to pyproject.toml in project.optional-dependencies [test] target
for the classmethod property, i found a suggestion here https://stackoverflow.com/a/76047344 for using a metaclass. So you can go that route. Or, which I encourage, is to think why it's needed - why is it important to have a class-property (not an instance-property) - perhaps a simple class-attribute would work?

Stacking classmethod and property is deprecated in CPython.

Otherwise the Horiba FHR driver cannot be imported and building fails.

astafan8 · 2023-10-19T08:57:24Z

qcodes_contrib_drivers/drivers/M2/M2_Solstis_3.py:142:37: error: X | Y syntax for unions requires Python 3.10 [syntax]

to sovle this you could add from __future__ import annotations at the top of the module

qcodes_contrib_drivers/drivers/Thermotek/Thermotek_T255p.py:5:1: error: Module "typing" has no attribute "ParamSpec"; maybe "_ParamSpec"? [attr-defined]

to solve this, i don't remember, but perhaps the minimum version of typing_extensions needs to be bumped or so.

astafan8 · 2023-10-19T08:58:43Z

@thangleiter instead of 83b844b you could add this module to autodoc mock imports like here https://github.com/QCoDeS/Qcodes/blob/main/docs/conf.py#L439

thangleiter · 2023-10-19T09:55:52Z

Mypy finally runs without errors locally on 3.9.

_CData cannot be imported

For reasons unclear to me, validation is performed before set_parsing, making the latter obsolete if validation for the set_parser type

codecov-commenter · 2023-10-19T15:02:03Z

Codecov Report

Merging #261 (d601bc2) into main (3c10e07) will decrease coverage by 0.54%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main     #261      +/-   ##
==========================================
- Coverage   20.17%   19.64%   -0.54%     
==========================================
  Files         146      153       +7     
  Lines       18260    18756     +496     
==========================================
  Hits         3684     3684              
- Misses      14576    15072     +496

Files	Coverage Δ
qcodes_contrib_drivers/drivers/Horiba/__init__.py	`0.00% <0.00%> (ø)`
...ntrib_drivers/drivers/Horiba/private/fhr_client.py	`0.00% <0.00%> (ø)`
...ntrib_drivers/drivers/Horiba/private/fhr_server.py	`0.00% <0.00%> (ø)`
...ghthousePhotonics/Lighthouse_Photonics_Sprout_G.py	`0.00% <0.00%> (ø)`
qcodes_contrib_drivers/drivers/M2/M2_Solstis_3.py	`0.00% <0.00%> (ø)`
...ntrib_drivers/drivers/Thermotek/Thermotek_T255p.py	`0.00% <0.00%> (ø)`
...codes_contrib_drivers/drivers/Horiba/Horiba_FHR.py	`0.00% <0.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Need to specify root package of the dependency: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports

thangleiter · 2023-10-20T15:02:54Z

... Docs should also be fixed now!

thangleiter and others added 30 commits April 5, 2023 16:41

Add Horiba FHR1000 driver.

00152eb

Possible extensions: - parse LabSpec6 config file to determine which motor sits at which address on the board to avoid having to manually set the IDs etc. at runtime. - otherwise, use a simple Python data structure to do the same.

Improve structure and add validators & val_mappings

344dc0c

Add example notebook.

ab18555

Add argument to stop() to raise errAbort exception

a7d765e

Make step a property

ed2a88d

Add width/relative position parameter

58bd503

Add note about step parameter for SlitChannels

be306e0

Merge branch 'main' into feature/horiba_fhr_1000_driver

a97896b

Rename _private to private

2b2bd6a

Add information to example notebook.

bcee2bd

Remove unnecessary parameters

fae1b1b

Rename without Model number

b446318

Rewrite to parse ini file for configuration.

b737e35

Add connect message statement

4acf55b

Dynamic dll filename argument

93b3821

In case someone wants to implement a newer version of the dll in the future.

Add Lighthouse Photonics Sprout G driver.

09605d8

Prepend Vendor to class name

a2daa36

Add Thermotek T255p chiller driver.

8e2466a

Simplify error handling

0381969

First version of Solstis 3 laser driver

188ec7f

# Conflicts: # qcodes_contrib_drivers/drivers/msquared/__init__.py # qcodes_contrib_drivers/drivers/msquared/solstis_3.py

add methods _get_status and _get_wavelength and _set_wavelength

3cbaa80

include verbose parameters if one wants to display the JSON strings

additional methods to control the wavelength tuning (locked or not)

d33eade

functions to get/set lock create parameters wavelength_t/wavelength_m and lock

Rename Solstis to conform with convention

249d7dd

Autoformat and sort imports:

48073e2

Update to new signatures and add some documentation.

fc050c8

Use DelegateGroupParameters for GroupedParameter's DelegateGroup.

e9a27f3

Units and get_parsers

3de9b47

PEP-8

d9b77e3

Add ramp_up method

9a86c02

Merge branch 'feature/m2_solstis_driver' into tmp

8ab8d05

Merge branch 'main' into feature/add_new_drivers

e9878e9

astafan8 approved these changes Oct 18, 2023

View reviewed changes

docs/examples/Horiba_FHR.ipynb Show resolved Hide resolved

docs/examples/Horiba_FHR.ipynb Show resolved Hide resolved

Block notebook from executing and add header cell

fe7441e

thangleiter added 3 commits October 18, 2023 19:33

Fix MyPy errors

ed893a6

Fix notebook headline

31fd087

Fix import

b0d1889

thangleiter added 5 commits October 19, 2023 09:48

add msl.loadlib to mypy overrides

479cfba

add types-tqdm to test dependencies

42cdc24

Make MotorChannel.type a classmethod

f3965ab

Stacking classmethod and property is deprecated in CPython.

Drop Python 3.8 workaround (not supported anymore)

0157185

Add msl.loadlib to doc requirements

83b844b

Otherwise the Horiba FHR driver cannot be imported and building fails.

thangleiter added 4 commits October 19, 2023 11:04

Mock import in autodoc instead of install msl.loadlib

0f0e847

Fix typing imports

7f1bde2

Fix remaining MyPy errors

e06e6df

Simplify calls to cli.SpeCommand

b58d1bd

thangleiter added 2 commits October 19, 2023 16:26

Use _SimpleCData instead of _CData for type

79576e3

_CData cannot be imported

Validate numbers instead of ints

d601bc2

For reasons unclear to me, validation is performed before set_parsing, making the latter obsolete if validation for the set_parser type

Fix mocking msl import

a189367

Need to specify root package of the dependency: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports

astafan8 enabled auto-merge October 23, 2023 07:30

astafan8 merged commit d991e11 into QCoDeS:main Oct 23, 2023
8 checks passed

thangleiter deleted the feature/add_new_drivers branch October 23, 2023 07:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a bunch of new drivers #261

Add a bunch of new drivers #261

thangleiter commented Oct 18, 2023

astafan8 commented Oct 18, 2023

astafan8 commented Oct 18, 2023

thangleiter commented Oct 18, 2023

astafan8 commented Oct 19, 2023

astafan8 commented Oct 19, 2023

astafan8 commented Oct 19, 2023

thangleiter commented Oct 19, 2023

codecov-commenter commented Oct 19, 2023 •

edited

Loading

thangleiter commented Oct 20, 2023

Add a bunch of new drivers #261

Add a bunch of new drivers #261

Conversation

thangleiter commented Oct 18, 2023

astafan8 commented Oct 18, 2023

astafan8 commented Oct 18, 2023

thangleiter commented Oct 18, 2023

astafan8 commented Oct 19, 2023

astafan8 commented Oct 19, 2023

astafan8 commented Oct 19, 2023

thangleiter commented Oct 19, 2023

codecov-commenter commented Oct 19, 2023 • edited Loading

Codecov Report

thangleiter commented Oct 20, 2023

codecov-commenter commented Oct 19, 2023 •

edited

Loading