mirror of
https://github.com/m-labs/artiq.git
synced 2024-12-25 03:08:27 +08:00
doc: clarify usage of pause/check_pause, closes #571
This commit is contained in:
parent
02adccf4a2
commit
69099691f7
@ -446,6 +446,9 @@ class Scheduler:
|
||||
whether returning control to the host and pausing would have an effect,
|
||||
in order to avoid the cost of switching kernels in the common case
|
||||
where ``pause`` does nothing.
|
||||
|
||||
This function does not have side effects, and does not have to be
|
||||
followed by a call to ``pause``.
|
||||
"""
|
||||
for pipeline in self._pipelines.values():
|
||||
if rid in pipeline.pool.runs:
|
||||
|
@ -72,7 +72,9 @@ To check whether ``pause()`` would in fact *not* return immediately, use :meth:`
|
||||
|
||||
The experiment must place the hardware in a safe state and disconnect from the core device (typically, by using ``self.core.comm.close()``) before calling ``pause``.
|
||||
|
||||
Accessing the ``pause`` method is done through a virtual device called ``scheduler`` that is accessible to all experiments. The scheduler virtual device is requested like regular devices using ``get_device`` or ``attr_device``.
|
||||
Accessing the ``pause`` and ``check_pause`` methods is done through a virtual device called ``scheduler`` that is accessible to all experiments. The scheduler virtual device is requested like regular devices using ``get_device`` or ``attr_device``.
|
||||
|
||||
``check_pause`` can be called (via RPC) from a kernel, but ``pause`` must not.
|
||||
|
||||
Multiple pipelines
|
||||
------------------
|
||||
|
Loading…
Reference in New Issue
Block a user