Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ genapi:
../qcodes/instrument_drivers/AimTTi \
../qcodes/instrument_drivers/AlazarTech \
../qcodes/instrument_drivers/basel \
../qcodes/instrument_drivers/Galil \
../qcodes/instrument_drivers/HP \
../qcodes/instrument_drivers/ithaco \
../qcodes/instrument_drivers/Keithley \
Expand Down
7 changes: 7 additions & 0 deletions docs/drivers_api/Galil.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _Galil_api :

Galil Drivers
=============

.. automodule:: qcodes.instrument_drivers.Galil
:autosummary:
1 change: 1 addition & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ sphinx-apidoc -o _auto -d 10 ..\qcodes ^
..\qcodes\instrument_drivers\AlazarTech ^
..\qcodes\instrument_drivers\american_magnetics\* ^
..\qcodes\instrument_drivers\basel ^
..\qcodes\instrument_drivers\Galil ^
..\qcodes\instrument_drivers\HP ^
..\qcodes\instrument_drivers\ithaco ^
..\qcodes\instrument_drivers\Keithley ^
Expand Down
13 changes: 13 additions & 0 deletions qcodes/instrument_drivers/Galil/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from .dmc_41x3 import (
GalilDMC4133Arm,
GalilDMC4133Controller,
GalilDMC4133Motor,
GalilDMC4133VectorMode,
)

__all__ = [
"GalilDMC4133Arm",
"GalilDMC4133Controller",
"GalilDMC4133Motor",
"GalilDMC4133VectorMode",
]
54 changes: 41 additions & 13 deletions qcodes/instrument_drivers/Galil/dmc_41x3.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,14 @@ def motion_complete(self, axes: str) -> None:
self.g.GMotionComplete(axes)


class VectorMode(InstrumentChannel):
class GalilDMC4133VectorMode(InstrumentChannel):
"""
Class to control motors in vector mode
"""

def __init__(self, parent: "DMC4133Controller", name: str, **kwargs: Any) -> None:
def __init__(
self, parent: "GalilDMC4133Controller", name: str, **kwargs: Any
) -> None:
"""
Initializes the vector mode submodule for the controller

Expand Down Expand Up @@ -226,12 +228,20 @@ def clear_sequence(self, coord_sys: str) -> None:
self.write(f"CS {coord_sys}")


class Motor(InstrumentChannel):
VectorMode = GalilDMC4133VectorMode
"""
Alias for backwards compatibility
"""


class GalilDMC4133Motor(InstrumentChannel):
"""
Class to control a single motor (independent of possible other motors)
"""

def __init__(self, parent: "DMC4133Controller", name: str, **kwargs: Any) -> None:
def __init__(
self, parent: "GalilDMC4133Controller", name: str, **kwargs: Any
) -> None:
"""
Initializes individual motor submodules

Expand Down Expand Up @@ -428,7 +438,13 @@ def error_magnitude(self) -> float:
return float(self.ask(f"QS{self._axis}=?"))


class DMC4133Controller(GalilMotionController):
Motor = GalilDMC4133Motor
"""
Alias for backwards compatibility
"""


class GalilDMC4133Controller(GalilMotionController):
"""
Driver for Galil DMC-4133 Controller
"""
Expand Down Expand Up @@ -471,12 +487,12 @@ def __init__(self, name: str, address: str, **kwargs: Any) -> None:
)

self._set_default_update_time()
self.add_submodule("motor_a", Motor(self, "A"))
self.add_submodule("motor_b", Motor(self, "B"))
self.add_submodule("motor_c", Motor(self, "C"))
self.add_submodule("plane_ab", VectorMode(self, "AB"))
self.add_submodule("plane_bc", VectorMode(self, "BC"))
self.add_submodule("plane_ac", VectorMode(self, "AC"))
self.add_submodule("motor_a", GalilDMC4133Motor(self, "A"))
self.add_submodule("motor_b", GalilDMC4133Motor(self, "B"))
self.add_submodule("motor_c", GalilDMC4133Motor(self, "C"))
self.add_submodule("plane_ab", GalilDMC4133VectorMode(self, "AB"))
self.add_submodule("plane_bc", GalilDMC4133VectorMode(self, "BC"))
self.add_submodule("plane_ac", GalilDMC4133VectorMode(self, "AC"))

def _set_default_update_time(self) -> None:
"""
Expand Down Expand Up @@ -556,7 +572,13 @@ def wait_till_motion_complete(self) -> None:
self.motors_off()


class Arm:
DMC4133Controller = GalilDMC4133Controller
"""
Alias for backwards compatibility
"""


class GalilDMC4133Arm:
"""
Module to control probe arm. It is assumed that the chip to be probed has
one or more rows with each row having one or more pads. Design of the
Expand All @@ -574,7 +596,7 @@ class Arm:
of the chip.
"""

def __init__(self, controller: DMC4133Controller) -> None:
def __init__(self, controller: GalilDMC4133Controller) -> None:
"""
Initializes the arm class

Expand Down Expand Up @@ -1080,3 +1102,9 @@ def _calculate_vector_component(vec: float, val: int) -> int:
assert return_val % 1024 == 0

return return_val


Arm = GalilDMC4133Arm
"""
Alias for backwards compatibility
"""