Skip to content

Update HP drivers to conform to docs standard #4461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bors merged 4 commits into from
Aug 3, 2022
Merged

Update HP drivers to conform to docs standard #4461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82ff286
Add toplevel imports for HP drivers
jenshnielsen Aug 2, 2022
97b7acf
Exclude HP drivers from old docs
jenshnielsen Aug 2, 2022
1ecc2ae
Add HP drivers to new api docs
jenshnielsen Aug 2, 2022
f4a7e93
use canonical import
jenshnielsen Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ genapi:
sphinx-apidoc -o _auto -d 10 ../qcodes \
../qcodes/instrument_drivers/agilent \
../qcodes/instrument_drivers/AimTTi \
../qcodes/instrument_drivers/HP \
../qcodes/instrument_drivers/ithaco \
../qcodes/instrument_drivers/keysight \
../qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/private/* \
Expand Down
7 changes: 7 additions & 0 deletions docs/drivers_api/HP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _hp_api :

Hewlett Packard Drivers
=======================

.. automodule:: qcodes.instrument_drivers.HP
:autosummary:
1 change: 1 addition & 0 deletions docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ REM for storing drivers, not the lower-case one).
sphinx-apidoc -o _auto -d 10 ..\qcodes ^
..\qcodes\instrument_drivers\agilent\* ^
..\qcodes\instrument_drivers\AimTTi ^
..\qcodes\instrument_drivers\HP ^
..\qcodes\instrument_drivers\ithaco ^
..\qcodes\instrument_drivers\QuantumDesign\DynaCoolPPMS\private\* ^
..\qcodes\instrument_drivers\stanford_research\* ^
Expand Down
99 changes: 4 additions & 95 deletions qcodes/instrument_drivers/HP/HP8133A.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,5 @@
from typing import Any
"""
Module left for backwards compatibility. Will be deprecated and removed eventually.
"""

from qcodes.instrument import VisaInstrument
from qcodes.validators import Numbers


class HP8133A(VisaInstrument):
"""
This is the code for Hewlett Packard 8133A Pulse Generator
"""

def __init__(
self,
name: str,
address: str,
reset: bool = False,
**kwargs: Any):
super().__init__(name, address, terminator='\n', **kwargs)

self.add_parameter(name='frequency',
label='Frequency',
unit='Hz',
get_cmd='FREQ?',
set_cmd='FREQ {}',
get_parser=float,
vals=Numbers(min_value=31.3e6,
max_value=3.5e9))
self.add_parameter(name='period',
label='Period',
unit='s',
get_cmd='PER?',
set_cmd='PER {}',
get_parser=float,
vals=Numbers(min_value=286e-12,
max_value=31.949e-9))
self.add_parameter(name='phase',
label='Phase',
unit='deg',
get_cmd='PHAS?',
set_cmd='PHAS {}',
get_parser=float,
vals=Numbers(min_value=-3.6e3,
max_value=3.6e3))
self.add_parameter(name='duty_cycle',
label='Duty cycle',
unit='%',
get_cmd='DCYC?',
set_cmd='DCYC {}',
get_parser=float,
vals=Numbers(min_value=0,
max_value=100))
self.add_parameter(name='delay',
label='Delay',
unit='s',
get_cmd='DEL?',
set_cmd='DEL {}',
get_parser=float,
vals=Numbers(min_value=-5e-9,
max_value=5e-9))
self.add_parameter(name='width',
label='Width',
unit='s',
get_cmd='WIDT?',
set_cmd='WIDT {}',
get_parser=float,
vals=Numbers(min_value=1e-12,
max_value=10.5e-9))
self.add_parameter(name='amplitude',
label='Amplitude',
unit='V',
get_cmd='VOLT?',
set_cmd='VOLT {}',
get_parser=float,
vals=Numbers(min_value=0.1,
max_value=3.3))
self.add_parameter(name='amplitude_offset',
label='Offset',
unit='V',
get_cmd='VOLT:OFFS?',
set_cmd='VOLT:OFFS {}',
get_parser=float,
vals=Numbers(min_value=-2.95,
max_value=3.95))
self.add_parameter(name='output',
label='Output',
get_cmd='OUTP?',
set_cmd='OUTP {}',
val_mapping={'OFF': 0,
'ON': 1})

# resets amplitude and offset each time user connects
self.amplitude(0.1)
self.amplitude_offset(0)

self.add_function('reset', call_cmd='*RST')
self.connect_message()
from HP_8133A import HP8133A
Loading