Skip to content

Commit

Permalink
Merge pull request #6114 from jenshnielsen/hp_refactor
Browse files Browse the repository at this point in the history 
 Refactor drivers HP -> Ithaco
  • Loading branch information
@jenshnielsen
jenshnielsen authored May 24, 2024
2 parents 50ebef6 + c7851c9 commit dbb23fc
Show file tree
Hide file tree
Showing 9 changed files with 303 additions and 179 deletions.
6 changes: 6 additions & 0 deletions docs/changes/newsfragments/6114.improved_driver
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
The HP, Harvard and Ithaco drivers shipping with QCoDeS
have been updated to ensure all Parameters are set as static
attributes that are documented and can be type checked. The docs for the same drivers have been
updated to not document inherited members. This makes the documentation significantly more readable
as it focuses on specific members for a given instrument. The documentation now also links superclasses.
Please consult these for inherited members.
1 change: 1 addition & 0 deletions docs/drivers_api/HP.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Hewlett Packard Drivers

.. automodule:: qcodes.instrument_drivers.HP
:autosummary:
:no-inherited-members:
1 change: 1 addition & 0 deletions docs/drivers_api/Harvard.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Harvard Drivers

.. automodule:: qcodes.instrument_drivers.Harvard
:autosummary:
:no-inherited-members:
1 change: 1 addition & 0 deletions docs/drivers_api/Ithaco.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Ithaco Drivers

.. automodule:: qcodes.instrument_drivers.ithaco
:autosummary:
:no-inherited-members:
29 changes: 20 additions & 9 deletions src/qcodes/instrument_drivers/HP/HP_8133A.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
if TYPE_CHECKING:
from typing_extensions import Unpack

from qcodes.parameters import Parameter


class HP8133A(VisaInstrument):
"""
Expand All @@ -23,7 +25,7 @@ def __init__(
):
super().__init__(name, address, **kwargs)

self.add_parameter(
self.frequency: Parameter = self.add_parameter(
name="frequency",
label="Frequency",
unit="Hz",
Expand All @@ -32,7 +34,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=31.3e6, max_value=3.5e9),
)
self.add_parameter(
"""Parameter frequency"""
self.period: Parameter = self.add_parameter(
name="period",
label="Period",
unit="s",
Expand All @@ -41,7 +44,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=286e-12, max_value=31.949e-9),
)
self.add_parameter(
"""Parameter period"""
self.phase: Parameter = self.add_parameter(
name="phase",
label="Phase",
unit="deg",
Expand All @@ -50,7 +54,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=-3.6e3, max_value=3.6e3),
)
self.add_parameter(
"""Parameter phase"""
self.duty_cycle: Parameter = self.add_parameter(
name="duty_cycle",
label="Duty cycle",
unit="%",
Expand All @@ -59,7 +64,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=0, max_value=100),
)
self.add_parameter(
"""Parameter duty_cycle"""
self.delay: Parameter = self.add_parameter(
name="delay",
label="Delay",
unit="s",
Expand All @@ -68,7 +74,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=-5e-9, max_value=5e-9),
)
self.add_parameter(
"""Parameter delay"""
self.width: Parameter = self.add_parameter(
name="width",
label="Width",
unit="s",
Expand All @@ -77,7 +84,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=1e-12, max_value=10.5e-9),
)
self.add_parameter(
"""Parameter width"""
self.amplitude: Parameter = self.add_parameter(
name="amplitude",
label="Amplitude",
unit="V",
Expand All @@ -86,7 +94,8 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=0.1, max_value=3.3),
)
self.add_parameter(
"""Parameter amplitude"""
self.amplitude_offset: Parameter = self.add_parameter(
name="amplitude_offset",
label="Offset",
unit="V",
Expand All @@ -95,13 +104,15 @@ def __init__(
get_parser=float,
vals=Numbers(min_value=-2.95, max_value=3.95),
)
self.add_parameter(
"""Parameter amplitude_offset"""
self.output: Parameter = self.add_parameter(
name="output",
label="Output",
get_cmd="OUTP?",
set_cmd="OUTP {}",
val_mapping={"OFF": 0, "ON": 1},
)
"""Parameter output"""

# resets amplitude and offset each time user connects
self.amplitude(0.1)
Expand Down
183 changes: 106 additions & 77 deletions src/qcodes/instrument_drivers/HP/HP_83650A.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
if TYPE_CHECKING:
from typing_extensions import Unpack

from qcodes.parameters import Parameter

log = logging.getLogger(__name__)


Expand Down Expand Up @@ -37,83 +39,110 @@ def __init__(
log.debug('Initializing instrument')
super().__init__(name, address, **kwargs)

self.add_parameter('frequency',
label='Frequency',
get_cmd='FREQ:CW?',
set_cmd='FREQ:CW {}',
vals=vals.Numbers(10e6, 40e9),
docstring='Microwave frequency, ....',
get_parser=float,
unit='Hz')

self.add_parameter('freqmode',
label='Frequency mode',
get_cmd='FREQ:MODE?',
set_cmd='FREQ:MODE {}',
vals=vals.Strings(),
get_parser=parsestr,
docstring='Microwave frequency mode, ....')

self.add_parameter('power',
label='Power',
get_cmd='SOUR:POW?',
set_cmd='SOUR:POW {}',
vals=vals.Numbers(-20, 20),
get_parser=float,
unit='dBm',
docstring='Microwave power, ....')

self.add_parameter('rfstatus',
label='RF status',
get_cmd=':POW:STAT?',
set_cmd=':POW:STAT {}',
val_mapping={'on': '1', 'off': '0'},
vals=vals.Strings(),
get_parser=parsestr,
docstring='Status, ....')

self.add_parameter('fmstatus',
label='FM status',
get_cmd=':FM:STAT?',
set_cmd=':FM:STAT {}',
val_mapping={'on': '1', 'off': '0'},
vals=vals.Strings(),
get_parser=parsestr,
docstring='FM status, ....')

self.add_parameter('fmcoup',
label='FM coupling',
get_cmd=':FM:COUP?',
set_cmd=':FM:COUP {}',
vals=vals.Strings(),
get_parser=parsestr,
docstring='FM coupling, ....')

self.add_parameter('amstatus',
label='AM status',
get_cmd=':AM:STAT?',
set_cmd=':AM:STAT {}',
val_mapping={'on': '1', 'off': '0'},
vals=vals.Strings(),
get_parser=parsestr,
docstring='AM status, ....')

self.add_parameter('pulsestatus',
label='Pulse status',
get_cmd=':PULS:STAT?',
set_cmd=':PULS:STAT {}',
val_mapping={'on': '1', 'off': '0'},
vals=vals.Strings(),
get_parser=parsestr,
docstring='Pulse status, ....')

self.add_parameter('pulsesource',
label='Pulse source',
get_cmd=':PULS:SOUR?',
set_cmd=':PULS:SOUR {}',
vals=vals.Strings(),
get_parser=parsestr,
docstring='Pulse source, ....')
self.frequency: Parameter = self.add_parameter(
"frequency",
label="Frequency",
get_cmd="FREQ:CW?",
set_cmd="FREQ:CW {}",
vals=vals.Numbers(10e6, 40e9),
docstring="Microwave frequency, ....",
get_parser=float,
unit="Hz",
)
"""Microwave frequency, ...."""

self.freqmode: Parameter = self.add_parameter(
"freqmode",
label="Frequency mode",
get_cmd="FREQ:MODE?",
set_cmd="FREQ:MODE {}",
vals=vals.Strings(),
get_parser=parsestr,
docstring="Microwave frequency mode, ....",
)
"""Microwave frequency mode, ...."""

self.power: Parameter = self.add_parameter(
"power",
label="Power",
get_cmd="SOUR:POW?",
set_cmd="SOUR:POW {}",
vals=vals.Numbers(-20, 20),
get_parser=float,
unit="dBm",
docstring="Microwave power, ....",
)
"""Microwave power, ...."""

self.rfstatus: Parameter = self.add_parameter(
"rfstatus",
label="RF status",
get_cmd=":POW:STAT?",
set_cmd=":POW:STAT {}",
val_mapping={"on": "1", "off": "0"},
vals=vals.Strings(),
get_parser=parsestr,
docstring="Status, ....",
)
"""Status, ...."""

self.fmstatus: Parameter = self.add_parameter(
"fmstatus",
label="FM status",
get_cmd=":FM:STAT?",
set_cmd=":FM:STAT {}",
val_mapping={"on": "1", "off": "0"},
vals=vals.Strings(),
get_parser=parsestr,
docstring="FM status, ....",
)
"""FM status, ...."""

self.fmcoup: Parameter = self.add_parameter(
"fmcoup",
label="FM coupling",
get_cmd=":FM:COUP?",
set_cmd=":FM:COUP {}",
vals=vals.Strings(),
get_parser=parsestr,
docstring="FM coupling, ....",
)
"""FM coupling, ...."""

self.amstatus: Parameter = self.add_parameter(
"amstatus",
label="AM status",
get_cmd=":AM:STAT?",
set_cmd=":AM:STAT {}",
val_mapping={"on": "1", "off": "0"},
vals=vals.Strings(),
get_parser=parsestr,
docstring="AM status, ....",
)
"""AM status, ...."""

self.pulsestatus: Parameter = self.add_parameter(
"pulsestatus",
label="Pulse status",
get_cmd=":PULS:STAT?",
set_cmd=":PULS:STAT {}",
val_mapping={"on": "1", "off": "0"},
vals=vals.Strings(),
get_parser=parsestr,
docstring="Pulse status, ....",
)
"""Pulse status, ...."""

self.pulsesource: Parameter = self.add_parameter(
"pulsesource",
label="Pulse source",
get_cmd=":PULS:SOUR?",
set_cmd=":PULS:SOUR {}",
vals=vals.Strings(),
get_parser=parsestr,
docstring="Pulse source, ....",
)
"""Pulse source, ...."""
self.connect_message()

def reset(self) -> None:
Expand Down
Loading

0 comments on commit dbb23fc

Please sign in to comment.