artiq/doc/manual/main_frontend_reference.rst

Main front-end tool reference
=============================

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 :doc:`utilities`) but these together comprise the main points of access for using ARTIQ as a system.

:mod:`artiq.frontend.artiq_run`
-------------------------------

.. argparse::
   :ref: artiq.frontend.artiq_run.get_argparser
   :prog: artiq_run
   :nodefault:

.. _frontend-artiq-master:

:mod:`artiq.frontend.artiq_master`
----------------------------------

.. argparse::
   :ref: artiq.frontend.artiq_master.get_argparser
   :prog: artiq_master
   :nodefault:

.. _frontend-artiq-client:

:mod:`artiq.frontend.artiq_client`
----------------------------------

.. argparse::
   :ref: artiq.frontend.artiq_client.get_argparser
   :prog: artiq_client
   :nodefault:


.. _frontend-artiq-dashboard:

:mod:`artiq.frontend.artiq_dashboard`
-------------------------------------

.. argparse::
   :ref: artiq.frontend.artiq_dashboard.get_argparser
   :prog: artiq_dashboard
   :nodefault:

:mod:`artiq.frontend.artiq_session`
-----------------------------------

.. argparse::
   :ref: artiq.frontend.artiq_session.get_argparser
   :prog: artiq_session
   :nodefault: