.. iq_readout documentation master file, created by
   sphinx-quickstart on Sat Jun 22 18:24:30 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the surface-sim documentation
========================================

.. toctree::
   :maxdepth: 1
   :hidden:

   intro
   user_guide
   api

**Version**: |release|

.. grid:: 1 1 2 2
    :gutter: 2 3 4 4

    .. grid-item-card::
        :img-top: _static/getting_started.svg
        :text-align: center

        Getting started
        ^^^

        New to surface-sim? Check out what it can offer.

        +++

        .. button-ref:: intro
            :expand:
            :color: secondary
            :click-parent:

            To the introduction

    .. grid-item-card::
        :img-top: _static/user_guide.svg
        :text-align: center
        :class-img-top: sd-width-25

        User guide
        ^^^

        The user guide provides in-depth information on the
        functionality of surface-sim with useful background information and explanation.

        +++

        .. button-ref:: user_guide
            :expand:
            :color: secondary
            :click-parent:

            To the user guide

    .. grid-item-card::
        :img-top: _static/api.svg
        :text-align: center

        API reference
        ^^^

        The reference guide contains a detailed description of the functions,
        modules, and objects included in surface-sim.

        +++

        .. button-ref:: api
            :expand:
            :color: secondary
            :click-parent:

            To the reference guide

    .. grid-item-card::
        :img-top: _static/contributor.svg
        :text-align: center

        Contributing to surface-sim
        ^^^

        Want to add to the codebase? Go to the GitHub page and contact the contributors.

        +++

        .. button-link:: https://github.com/MarcSerraPeralta/surface-sim
            :expand:
            :color: secondary
            :click-parent:

            To GitHub