mirror of
https://github.com/ivan-usov-org/bec.git
synced 2025-04-21 18:20:01 +02:00
16 lines
1.2 KiB
ReStructuredText
16 lines
1.2 KiB
ReStructuredText
#############
|
|
Glossary
|
|
#############
|
|
|
|
.. glossary::
|
|
:sorted:
|
|
|
|
scanID
|
|
The ``scanID`` is the unique identifier for a scan. It is a string, typically uuid4, that is generated automatically by the scan server. It is used to uniquely identify a scan, even across multiple experiments and beamlines.
|
|
scan_number
|
|
The ``scan_number`` is an integer that is assigned to a scan by the scan server. It can be used to identify a scan within an experiment but is typically reset to 1 for each new experiment. The ``scan_number`` is also used by the file_writer to name the files that are generated by a scan.
|
|
requestID
|
|
The ``requestID`` is an identifier for a request to the scan server. As of now, it is a uuid4 string that is generated by the bec_lib during the preparation of a new request. A scan can comprise instructions from multiple requests.
|
|
queueID
|
|
The ``queueID`` is an identifier for an element in a queue. Each queue element can contain multiple scans and thus enforce the sequential execution of those scans. The ``queueID`` is a uuid4 string that is generated by the bec_lib during the preparation of a new queue element.
|
|
|