Skip to content

Update Dynacool drivers to conform to docs standard #4596

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
jenshnielsen merged 4 commits into from
Sep 12, 2022
Merged

Update Dynacool drivers to conform to docs standard #4596

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
9445d9c
Split server into method that can be called
jenshnielsen Sep 11, 2022
faa0cc8
Add dynacool to public api
jenshnielsen Sep 11, 2022
4c6ac45
Add entrypoint for dynacool server
jenshnielsen Sep 11, 2022
4f7b3da
Add dynacool to new api
jenshnielsen Sep 11, 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
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ genapi:
../qcodes/instrument_drivers/keysight \
../qcodes/instrument_drivers/Lakeshore \
../qcodes/instrument_drivers/QDev/* \
../qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/private/* \
../qcodes/instrument_drivers/QuantumDesign/* \
../qcodes/instrument_drivers/rigol/* \
../qcodes/instrument_drivers/rohde_schwarz/* \
../qcodes/instrument_drivers/stahl/*\
Expand Down
7 changes: 7 additions & 0 deletions docs/drivers_api/QuantumDesign.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _quantumdesign_api :

Quantum Design Drivers
======================

.. automodule:: qcodes.instrument_drivers.QuantumDesign
:autosummary:
2 changes: 1 addition & 1 deletion docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ sphinx-apidoc -o _auto -d 10 ..\qcodes ^
..\qcodes\instrument_drivers\ithaco ^
..\qcodes\instrument_drivers\Keithley ^
..\qcodes\instrument_drivers\Lakeshore ^
..\qcodes\instrument_drivers\QuantumDesign\DynaCoolPPMS\private\* ^
..\qcodes\instrument_drivers\QuantumDesign\* ^
..\qcodes\instrument_drivers\QDev\* ^
..\qcodes\instrument_drivers\rigol\* ^
..\qcodes\instrument_drivers\rohde_schwarz\* ^
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ docs = [

[project.scripts]
qcodes-monitor = "qcodes.monitor.monitor:main"
qcodes-dynacool-server = "qcodes.instrument_drivers.QuantumDesign.DynaCoolPPMS.private.server:run_server"

[tool.coverage.run]
omit = [
Expand Down
4 changes: 3 additions & 1 deletion qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/DynaCool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ class DynaCool(VisaInstrument):
"""
Class to represent the DynaCoolPPMS

Note that this driver assumes the server.py (from the 'private' folder)
Note that this driver assumes the server
to be running on the DynaCool dedicated control PC.
The server can be launched using `qcodes-dynacool-server.exe`
or by executing server.py (from the 'private' folder)

Args:
name: The name used internally by QCoDeS for this driver
Expand Down
8 changes: 6 additions & 2 deletions qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/private/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
ADDRESS = ''
LINE_TERM = '\r\n'

if __name__ == '__main__':

def run_server() -> None:

server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
Expand Down Expand Up @@ -89,5 +90,8 @@
response = command_handler(command)
sock.send(bytes(f'{response}{LINE_TERM}', 'utf-8'))


server_socket.close()


if __name__ == "__main__":
run_server()
3 changes: 3 additions & 0 deletions qcodes/instrument_drivers/QuantumDesign/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from .DynaCoolPPMS.DynaCool import DynaCool

__all__ = ["DynaCool"]