.. _ecosystem:

The Atomiq Ecosystem
====================

The Atomiq one orchestration framework is composed of several submodules:

.. image:: ../static/atomiq_one_scheme.svg
  :width: 100%
  :alt: Atomiq one ecosystem overview


We distinguish between two main areas: **Atomiq**, which handles the control of **realtime** devices (for now we support ARTIQ) and **HEROS** which handles the control of **non-realtime devices, data flow and connectivity**.

You can learn more about the individual components by visiting their individual documentation or **follow our getting started** :ref:`guide <getting_started_heros>`!

.. card::  :repo-doc-link:`HEROS <heros>`

    HEROS is the core backend of the framework. It makes objects network transparent (we then call a HERO [#f1]_), handles event and manages data flow and connections.
    **If you just want to use existing drivers you typically don't need to interact with it directly.**

    .. tip::

       You can use our `HERO Monitor <https://gitlab.com/atomiq-project/hero-monitor>`_ to see all your HEROs and interact with them.

    .. [#f1] A single network transparent object we call a HERO (Highly Efficient Remote Object) with plural: HEROs, not to be confused with the service HEROS


.. card::  :repo-doc-link:`BOSS <boss>`

   BOSS is an orchestrator service which is used to make a HERO (network transparent objects) out of any ordinary Python object.

   .. tip::

      This is a good :ref:`starting point <getting_started_heros>` if you want to start with connecting your non real-time hardware (monitoring, lasers, ...).

   .. tip::

      The :repo-doc-link:`HEROS devices repository <herosdevices>` provides drivers for a multitude of devices (see :ref:`hardware` for all supported devices)

.. card:: :repo-doc-link:`Atomiq <atomiq>`

   Atomiq is a transparent layer on top of ARTIQ with several paradigms to reduce boilerplate code, get rid of nix and make working with physically relevant quantities easier.

   It is tightly integrated with HEROS, but can also be used stand alone.

   .. tip::

      This is a good :ref:`starting point <getting_started_atomiq>` if you want to start with connecting your real-time hardware (ARTIQ).