Skip to content

Commit

Permalink
Merge pull request #286 from jenshnielsen/fix_docs_links
Browse files Browse the repository at this point in the history
fix links to qcodes docs
  • Loading branch information
jenshnielsen authored Jan 9, 2024
2 parents 71d4421 + 5bca79d commit d80e337
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 26 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The documentations of the drivers in this repository can be read `here <https://
Contributing
############

This repository is open for contribution of new drivers,
This repository is open for contribution of new drivers,
as well as improvements to existing drivers. Each driver should
contain an implementation of the driver and a Jupyter notebook showing how the
driver should be used. In addition we strongly encourage writing tests for the drivers.
Expand All @@ -52,8 +52,8 @@ while examples should be added to the ``docs/examples`` folder and tests placed
``qcodes_contrib_drivers/tests/MakerOfInstrument`` folder. Please follow naming conventions for
consistency.

For general information about writing drivers and how to write tests refer to the `QCoDeS documentation <http://qcodes.github.io/Qcodes/>`_.
Especially the examples `here <https://qcodes.github.io/Qcodes/examples/index.html#writing-drivers>`__
For general information about writing drivers and how to write tests refer to the `QCoDeS documentation <http://microsoft.github.io/Qcodes/>`_.
Especially the examples `here <https://microsoft.github.io/Qcodes/examples/index.html#writing-drivers>`__
are useful.

LICENSE
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
}


Expand Down
40 changes: 18 additions & 22 deletions qcodes_contrib_drivers/drivers/Rigol/Rigol_DSG3136B.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down Expand Up @@ -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 {}',
Expand All @@ -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',
Expand All @@ -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',
Expand All @@ -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 {}',
Expand Down Expand Up @@ -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 {}',
Expand Down Expand Up @@ -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 {}',
Expand Down Expand Up @@ -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')




0 comments on commit d80e337

Please sign in to comment.