Skip to content

Commit

Permalink
docs:usage: correct workflow subtext
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximilian Hanauske committed Dec 1, 2023
1 parent 78b78c7 commit 1a31b67
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/content/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ Usage
=====

The setup is running on Linux and Windows. Mac compatibility for the Analysis code is currently in development.
The pdf embedded is the AFMD's user manual and is meant as an example on how to use the sEQE setup. However, the document contains multiple AFMD specific references which are not needed for third party users and can thus be ignored. A more general version of the user manual is being developed.
A schematic of the operational workflow of a sEQE measurement is shown below. The numbers refer to the sections in the graphical user interface - see :doc:'../control_generated/modules' - that perform the corresponding operations. After instrument initialisation, the user can perform measurements of reference diodes or samples under testing. This requires alignment of the sample and selection of measurement parameters. During the measurement, live plots show measurement progress. Once the measurements are finished, detailed data analysis can be performed, for instance using our custom-written sEQE analysis code

.. image:: ../_static/operational_flow.png
:width: 700
:alt: Schematic of the operational workflow of sEQE measurements. The numbers refer to the sections in the graphical user interface - see :doc:'../control_generated/modules' - that perform the corresponding operations. After instrument initialisation, the user can perform measurements of reference diodes or samples under testing. This requires alignment of the sample and selection of measurement parameters. During the measurement, live plots show measurement progress. Once the measurements are finished, detailed data analysis can be performed, for instance using our custom-written sEQE analysis code
:alt: Schematic of the operational workflow of sEQE measurements.

The pdf embedded is the AFMD's user manual and is meant as an example on how to use the sEQE setup. However, the document contains multiple AFMD specific references which are not needed for third party users and can thus be ignored. A more general version of the user manual is being developed.

:pdfembed:`src:../_static/sEQE_measurement_User_Guide.pdf, height:800, width:650, align:middle`.

0 comments on commit 1a31b67

Please sign in to comment.