From 9b5b4c07eaa4994c659b73d8ec15693424fdc4c0 Mon Sep 17 00:00:00 2001 From: architeuthidae Date: Thu, 21 Nov 2024 18:09:10 +0100 Subject: [PATCH] doc: note use of scheduler attributes --- doc/manual/management_system.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/manual/management_system.rst b/doc/manual/management_system.rst index 69a575cbf..02b0fabd5 100644 --- a/doc/manual/management_system.rst +++ b/doc/manual/management_system.rst @@ -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 ----------------