M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc: note use of scheduler attributes

This commit is contained in:
architeuthidae 2024-11-21 18:09:10 +01:00 committed by Sébastien Bourdeauducq
parent 61c311fc54
commit 9b5b4c07ea
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/manual/management_system.rst
View File

@ -156,6 +156,11 @@ Accessing the :meth:`pause` and :meth:`~artiq.master.scheduler.Scheduler.check_p
:meth:`~artiq.master.scheduler.Scheduler.check_pause` can be called (via RPC) from a kernel, but :meth:`pause` cannot be.
Scheduler attributes
^^^^^^^^^^^^^^^^^^^^
The ``scheduler`` virtual device also exposes information about an experiment's scheduling status through the attributes ``rid``, ``pipeline_name``, ``priority``, and ``expid``. This allows e.g. access to an experiment's current RID as ``self.scheduler.rid``.
Internal details
----------------