The Atomiq Project
==================

.. card:: Quantum Hardware Orchestration Made Easy

  The atomiq project is a software framework to build an intuitive interface to manage and control every piece of hardware and every data stream in your lab.
  It is a quantum firmware that allows you to control your complex quantum hardware like a neutral atom or ion trap setup as it would be one device.

  .. tip::

    This page is the central documentation of the framework, here you will find an overview of the project, tutorials and more. If you look for something specifically for
    a module, like `BOSS <https://boss-eb4966.gitlab.io>`_, you find the individual documentation pages in the sidebar or on the :ref:`ecosystem <ecosystem>` page.

.. grid:: 2

    .. grid-item-card::  Tutorials and Getting Started :octicon:`workflow;1.2em;sd-text-info`
      :link: tutorials
      :link-type: ref

      Learn how to set up Atomiq/HEROS to control your experiment ...

    .. grid-item-card::  About the Ecosystem :octicon:`globe;1.2em;sd-text-info`
      :link: ecosystem
      :link-type: ref

      Learn more about the different components of the Atomiq project ...

    .. grid-item-card::  Supported Devices :octicon:`plug;1.2em;sd-text-info`
      :link: hardware-index
      :link-type: ref

      Overview over supported devices ...

    .. grid-item-card::  Usecases and Examples :octicon:`book;1.2em;sd-text-info`
      :link: usecases
      :link-type: ref

      A list of usecases in quantum labs and examples to get you started ...

.. toctree::
   :maxdepth: 2
   :hidden:

   ecosystem
   tutorials/index
   hardware/index
   generated/faq
   generated/breaking
   contributing