Skip to content

Commit

Permalink
Changed order of doc, added placeholders for missing scripts.
Browse files Browse the repository at this point in the history
  • Loading branch information
TillHuckemann committed Jan 3, 2025
1 parent c489da4 commit 546bb81
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 7 deletions.
42 changes: 36 additions & 6 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,41 @@ All gettable (and static gettable) parameters will be recorded, static and dynam
The minimum timestep is limited by time it takes to record the measurement values. If you choose small timesteps compared to the measurement speed and communication time it might affect
the stepsize and duration of the complete measurement. Use custom measurement scripts to perform very fast or high-precision measurements.

There is also a buffered version of this script.

####################
Timetrace with Sweeps (buffered)
####################

Doc missing, check :ref:`API_DOC`, measurement/scripts

####################
Pulsed Measurements (buffered)
####################

Doc missing, check :ref:`API_DOC`, measurement/scripts


################################
Generic_Pulsed_Repeated_Measurement
################################

Doc missing, check :ref:`API_DOC`, measurement/scripts


#####################
1D Hysteresis Sweeps (buffered)
#####################

Doc missing, check :ref:`API_DOC`, measurement/scripts


########################
2D Sweeps buffered
########################

Doc missing, check :ref:`API_DOC`, measurement/scripts


#####################################
Writing your own measurement scripts (WIP)
Expand Down Expand Up @@ -362,12 +397,7 @@ Therefore, we included some useful method in the "utils" section of QuMADA.

.. _BufferedMeasurements:
Buffered Measurements
----------------------


#############################
Buffered 1D Measurements
#############################
-------------------------------------

Buffered measurements are required, as the communication between the measurement PC and the measurement hardware can slow down measurement significantly. For unbuffered measurements QuMADA has to send get and set commands to the measurement hardware for every datapoint,
whereas buffered measurements just require communication for starting the measurement and for reading the data afterwards.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Welcome to QuMADA's documentation!

installation
tutorials
examples
device_object
examples
mapping_gui
metadata
qumada
Expand Down

0 comments on commit 546bb81

Please sign in to comment.