.. _frontend:

Frontend
========

Atomiq Dashboard
----------------

Atomiq comes with a modified `ARTIQ Dashboard <https://m-labs.hk/artiq/manual/using_data_interfaces.html>`_
with a couple of extra features. It can be started by running

.. tab-set::

   .. tab-item:: uv

      .. code-block::

        uv run atomiq_dashboard


   .. tab-item:: other

      .. code-block:: bash

        source /path/to/your/venv/bin/activate && atomiq_dashboard


See :ref:`here <install-dashboard-only>` for more information.

.. image:: img/dashboard.svg


The dashboard works exactly the same as the stock ARTIQ one with the following extras:

#. Scannable parameters take up much less space when they are set to "No Scan".
#. Box to set the order in which parameters are scanned via drag and drop. :code:`Sort by name` forces lexicographical ordering.

   .. note::

      Then scan order is logged at the start of each experiment run. Arguments higher in the list
      (smaller values) are scanned first. This means in a scenario where :code:`arg1 = 0,1; arg2= 10,11`
      and arg1 is the first argument in the list, the scan points :code:`(arg1, arg2)` are ordered
      as follows: :code:`(0,10) -> (1,10) -> (0,11) -> (1,11)`.

#. Parameter search bar to search for experiment arguments.
#. Better scroll behaviour and alternating parameter row highlighting.


.. admonition:: Troubleshooting
   :collapsible: closed
   :class: error

   **The Dashboard quickly opens and then crashes without error**
      This is typically a sign of a broken dashboard state file. Backup and delete the ``.pyon`` `state file <https://m-labs.hk/artiq/manual/management_system.html#clients>`_. The dashboard will recreate it on the next launch.


.. _frontend_master:

Atomiq Master
-------------

.. important::

   Note, that the master should be run in a docker container. :ref:`Here <installation>` you can find a tutorial how
   to do this. Running it on your host machine will mostl likely fail.


The atomiq master is a patched version of the ARTIQ master with the following additional feature:

- It exposes infrastructure like the scheduler as :ref:`HEROs <heros in atomiq>` for tight integration.
- It improves the git experiment repository integration of `ARTIQ <https://m-labs.hk/artiq/manual/getting_started_mgmt.html#setting-up-git-integration>`_. Learn more :ref:`here <atomiq_git_integration>`.


It can be started by running

.. code-block:: bash

  python -m atomiq.frontend.atomiq_master

.. argparse::
   :module: atomiq.frontend.atomiq_master
   :func: get_argparser
   :prog: atomiq_master