diff --git a/README.rst b/README.rst
index 0aea19aac..393d51bca 100644
--- a/README.rst
+++ b/README.rst
@@ -40,7 +40,7 @@ The documentations of the drivers in this repository can be read `here `_.
-Especially the examples `here `__
+For general information about writing drivers and how to write tests refer to the `QCoDeS documentation `_.
+Especially the examples `here `__
are useful.
LICENSE
diff --git a/docs/conf.py b/docs/conf.py
index 9f45ba405..d3d040e20 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -101,7 +101,7 @@
"https://ipython.readthedocs.io/en/stable/",
None,
),
- "qcodes": ("https://qcodes.github.io/Qcodes/", None),
+ "qcodes": ("https://microsoft.github.io/Qcodes/", None),
}
diff --git a/qcodes_contrib_drivers/drivers/Rigol/Rigol_DSG3136B.py b/qcodes_contrib_drivers/drivers/Rigol/Rigol_DSG3136B.py
index 60dbe27b8..ece8d2f76 100644
--- a/qcodes_contrib_drivers/drivers/Rigol/Rigol_DSG3136B.py
+++ b/qcodes_contrib_drivers/drivers/Rigol/Rigol_DSG3136B.py
@@ -5,25 +5,25 @@
Examples:
***Setting up and testing instrument control***
-
+
On Edward's PC, it seems to be necessary to run UltraSigma (Rigol's proprietary interface program), then unplug and replug USB, then run the Python commands below. After that you can shut down UltraSigma and Python will run happily.
-
+
$ from qcodes.instrument_drivers.rigol.Rigol_DSG3136B import RigolDSG3136B
$ sg_1 = RigolDSG3136B('r_3136B_1', 'USB0::0x1AB1::0x099C::DSG3E244600050::INSTR')
$ sg_1.identify() # Should return the name of the instrument
$ sg_1.output('1') # Turn output on
$ sg_1.frequency(1e9) # Set the instrument frequency
$ sg_1.level(-20.57) # Set the instrument power level
-
+
If you have set up QCoDes with dummy instruments (following
- https://qcodes.github.io/Qcodes/examples/15_minutes_to_QCoDeS.html ) and have set up doND (following
- https://qcodes.github.io/Qcodes/examples/DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.html ) then you should also be able to execute:
+ https://microsoft.github.io/Qcodes/examples/15_minutes_to_QCoDeS.html ) and have set up doND (following
+ https://microsoft.github.io/Qcodes/examples/DataSet/Using_doNd_functions_in_comparison_to_Measurement_context_manager_for_performing_measurements.html ) then you should also be able to execute:
$ station.add_component(sg_1)
$ do1d(sg_1.level, -50, -20, 11, 0, dmm.v1, dmm.v2, show_progress=True, do_plot=True)
-
-
+
+
***Using sweep mode***
-
+
Sweep mode is a faster way of stepping through a series of data points than setting frequency or power at every step.
To sweep from 1 GHz to 2 GHz in 11 steps then do:
$ sg_1.sweep('FREQ')
@@ -72,7 +72,7 @@ def __init__(self, name, address, **kwargs):
get_parser=str.rstrip
)
"""Send identification code"""
-
+
self.add_parameter('output',
label='Output state',
set_cmd=':OUTPut:STATe {}',
@@ -85,7 +85,7 @@ def __init__(self, name, address, **kwargs):
vals=vals.Enum('OFF', 'ON')
)
"""Turns on or off the RF output, e.g. sg_1.output('0') or sg_1.output('OFF')"""
-
+
self.add_parameter(name='frequency',
label='Frequency',
unit='Hz',
@@ -95,7 +95,7 @@ def __init__(self, name, address, **kwargs):
vals=vals.Numbers(9e3, 13.6e9)
)
"""Control the output frequency"""
-
+
self.add_parameter(name='level',
label='Level',
unit='dBm',
@@ -105,7 +105,7 @@ def __init__(self, name, address, **kwargs):
vals=vals.Numbers(-130, 27)
)
"""Control the output power level"""
-
+
self.add_parameter('sweep_direction',
label='Sweep direction',
set_cmd=':SOURce:SWEep:DIRection {}',
@@ -139,7 +139,7 @@ def __init__(self, name, address, **kwargs):
vals=vals.Enum('AUTO', 'KEY', 'BUS', 'EXT')
)
"""Control the trigger mode of the sweep period (i.e. the trigger required to restart the sweep)"""
-
+
self.add_parameter('point_trigger',
label='Point trigger',
set_cmd=':SOURce:SWEep:POINt:TRIGger:TYPE {}',
@@ -215,7 +215,7 @@ def __init__(self, name, address, **kwargs):
vals=vals.Numbers(9e3,3.6e9),
unit='Hz'
)
-
+
self.add_parameter('sweep_frequency_stop',
label='Sweep start frequency',
set_cmd=':SOURce:SWEep:STEP:STOP:FREQuency {}',
@@ -300,28 +300,24 @@ def __init__(self, name, address, **kwargs):
get_parser=str.rstrip,
vals=vals.Enum('LIST','STEP')
)
-
+
# As recommended by QCoDeS, it's a good idea to call connect_message at the end of your constructor.
self.connect_message()
-
+
def trigger(self) -> None:
"""
Generates a trigger event. This is equivalent to pressing the Force Trigger button on front panel.
"""
self.write('*TRG')
-
+
def sweep_reset(self) -> None:
"""
Resets a sweep to the beginning of its range.
"""
self.write(':SOURce:SWEep:RESet:ALL')
-
+
def sweep_execute(self) -> None:
"""
Executes a sweep
"""
self.write(':SOURce:SWEep:EXECute')
-
-
-
-