Main front-end tools

These are the top-level commands used to run and manage ARTIQ experiments. Not all of the ARTIQ front-end is described here (many additional useful commands are presented in this manual in Utilities) but these together comprise the main points of access for using ARTIQ as a system.

artiq.frontend.artiq_run

artiq.frontend.artiq_master

artiq.frontend.artiq_client

artiq.frontend.artiq_dashboard

artiq.frontend.artiq_browser

artiq.frontend.artiq_session

ARTIQ session manager. Automatically runs the master, dashboard and local controller manager on the current machine. The latter requires the artiq-comtools package to be installed.

When supplying arguments to individual front-end tools, use = to avoid ambiguity in argument parsing, e.g.:

artiq_session -m=-g -m=--device-db=alternate_device_db.py -c=-v

and so on.

usage: artiq_session [-h] [--version] [-m M] [-d D] [-c C]

Named Arguments

--version

print the ARTIQ version number

-m

add argument to the master command line

-d

add argument to the dashboard command line

-c

add argument to the controller manager command line

artiq_comtools.artiq_ctlmgr

ARTIQ controller manager. Supplied in the separate package artiq-comtools, which is included with a standard ARTIQ installation but can also be installed standalone, with the intention of making it easier to run controllers and controller managers on machines where a full ARTIQ installation may not be necessary or convenient.

usage: artiq_ctlmgr [-h] [-v] [-q] [-s SERVER] [--port-notify PORT_NOTIFY]
                    [--port-logging PORT_LOGGING]
                    [--retry-master RETRY_MASTER] [--host-filter HOST_FILTER]
                    [--bind BIND] [--no-localhost-bind]
                    [--port-control PORT_CONTROL]

Named Arguments

-s, --server

hostname or IP of the master to connect to

--port-notify

TCP port to connect to for notifications

--port-logging

TCP port to connect to for logging

--retry-master

retry timer for reconnecting to master

--host-filter

IP address of controllers to launch (local address of master connection by default)

verbosity

-v, --verbose

increase logging level

-q, --quiet

decrease logging level

network server

--bind

additional hostname or IP address to bind to; use ‘*’ to bind to all interfaces (default: [])

--no-localhost-bind

do not implicitly also bind to localhost addresses

--port-control

TCP port for control connections (default: 3249)