diff options
| author | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-13 19:12:02 -0400 |
|---|---|---|
| committer | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-13 19:12:02 -0400 |
| commit | 01cdb3e0fdc9964f46381b0549aec839666ac5b5 (patch) | |
| tree | 90c4bd97d8a3f820f0f2c0cf002989a5dea7accf /qolab/hardware | |
| parent | 3a4f82210ef7f9757aae40eb25d869c7bf5c0b8c (diff) | |
| download | qolab-01cdb3e0fdc9964f46381b0549aec839666ac5b5.tar.gz qolab-01cdb3e0fdc9964f46381b0549aec839666ac5b5.zip | |
improved doc string
Diffstat (limited to 'qolab/hardware')
| -rw-r--r-- | qolab/hardware/lockin/__init__.py | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/qolab/hardware/lockin/__init__.py b/qolab/hardware/lockin/__init__.py index 4f27414..5190d69 100644 --- a/qolab/hardware/lockin/__init__.py +++ b/qolab/hardware/lockin/__init__.py @@ -3,6 +3,9 @@ from qolab.hardware.basic import BasicInstrument class Lockin(BasicInstrument): + """Basic lockin class with. + Intended to be expanded in hardware specific classes. + """ def __init__(self, *args, **kwds): BasicInstrument.__init__(self, *args, **kwds) self.config["Device type"] = "Lockin" @@ -29,10 +32,13 @@ class Lockin(BasicInstrument): class LockinSCPI(SCPIinstr, Lockin): - """ - Do not instantiate directly, use - rm = pyvisa.ResourceManager() - LockinSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR')) + """Basic lockin class with SCPI interface. + Intended to be expanded in hardware specific classes. + + Example + ------- + >>> rm = pyvisa.ResourceManager() + >>> LockinSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR')) """ pass |