Skip to content

Commit 2e59164

Browse files
author
Thomas Lemon
committed
Update fastsweep docstring example usage.
1 parent b484d87 commit 2e59164

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

src/qcodes/instrument_drivers/Keithley/_Keithley_2600.py

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -878,19 +878,49 @@ def __init__(self, parent: Instrument, name: str, channel: str) -> None:
878878
)
879879
"""
880880
Performs a fast sweep. Configure with setup_fastsweep() before use.
881-
Call fastsweep on the **inner** channel (the one from the first LinSweep).
882881
883-
Example 1D:
882+
Call ``fastsweep`` on the **inner** channel (the one from the first
883+
:class:`~qcodes.dataset.LinSweep`). Calling this parameter (or using
884+
``.get()``) returns the fast sweep data as a NumPy ``ndarray`` with
885+
shape determined by the configured sweep(s).
886+
887+
**Direct usage (returns ndarray)**
888+
889+
Example 1D::
890+
884891
>>> from qcodes.dataset import LinSweep
885892
>>> keith.smua.setup_fastsweep(LinSweep(keith.smua.volt, 0, 1, 100))
893+
>>> data = keith.smua.fastsweep() # or: keith.smua.fastsweep.get()
894+
>>> data.shape
895+
(100,)
896+
897+
Example 2D (inner=smub, outer=smua)::
898+
899+
>>> from qcodes.dataset import LinSweep
900+
>>> keith.smua.setup_fastsweep(
901+
... LinSweep(keith.smub.volt, 0, 1, 100), # inner
902+
... LinSweep(keith.smua.volt, 0, 0.5, 20), # outer
903+
... )
904+
>>> data = keith.smub.fastsweep() # call on inner channel
905+
>>> data.shape
906+
(20, 100)
907+
908+
**Dataset logging with do0d**
909+
910+
To log the fast sweep into a QCoDeS dataset, use :func:`do0d`
911+
with the ``fastsweep`` parameter::
912+
913+
>>> from qcodes.dataset import LinSweep, do0d
914+
>>> keith.smua.setup_fastsweep(LinSweep(keith.smua.volt, 0, 1, 100))
886915
>>> ds, _, _ = do0d(keith.smua.fastsweep)
887916
888-
Example 2D (inner=smub, outer=smua):
917+
For a 2D sweep (inner=smub, outer=smua)::
918+
919+
>>> from qcodes.dataset import LinSweep, do0d
889920
>>> keith.smua.setup_fastsweep(
890-
... LinSweep(keith.smub.volt, 0, 1, 100), # inner
921+
... LinSweep(keith.smub.volt, 0, 1, 100), # inner
891922
... LinSweep(keith.smua.volt, 0, 0.5, 20), # outer
892923
... )
893-
>>> ds, _, _ = do0d(keith.smub.fastsweep) # call on inner channel
894924
"""
895925

896926
self.timetrace_npts: Parameter = self.add_parameter(

0 commit comments

Comments
 (0)