From 7299a2cf02692300e01fe301381c9423471d6368 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Sun, 15 Feb 2015 14:55:15 -0700 Subject: [PATCH] doc/manual/management: add short descriptions of tools --- doc/manual/management_system.rst | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/doc/manual/management_system.rst b/doc/manual/management_system.rst index 669e910a7..ca6c35a98 100644 --- a/doc/manual/management_system.rst +++ b/doc/manual/management_system.rst @@ -4,13 +4,32 @@ Management system Master ------ +The master is responsible for managing the parameter and device databases, the experiment repository, scheduling and running experiments, archiving results, and distributing real-time results. + +The master is a headless component, and one or several clients (command-line or GUI) use the network to interact with it. + .. argparse:: :ref: artiq.frontend.artiq_master.get_argparser :prog: artiq_master +Controller manager +------------------ + +Controller managers are responsible for running and stopping controllers on a machine. There is one controller manager per network node that runs controllers. + +A controller manager connects to the master and uses the device database to determine what controllers need to be run. Changes in the device database are tracked by the manager and controllers are started and stopped accordingly. + +Controller managers use the local network address of the connection to the master to filter the device database and run only those controllers that are allocated to the current node. Hostname resolution is supported. + +.. argparse:: + :ref: artiq.frontend.artiq_ctlmgr.get_argparser + :prog: artiq_ctlmgr + Command-line client ------------------- +The command-line client connects to the master and permits modification and monitoring of the databases, monitoring the experiment schedule, and submitting experiments. + .. argparse:: :ref: artiq.frontend.artiq_client.get_argparser :prog: artiq_client @@ -18,13 +37,8 @@ Command-line client GUI client ---------- +The GUI client connects to the master and is the main way of interacting with it. + .. argparse:: :ref: artiq.frontend.artiq_gui.get_argparser :prog: artiq_gui - -Controller manager ------------------- - -.. argparse:: - :ref: artiq.frontend.artiq_ctlmgr.get_argparser - :prog: artiq_ctlmgr