Fringes documentation
=====================

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

    01_start/index
    02_tutorial/index
    03_api/index
    04_contribute/index

*Fringes* is an easy to use, pure-python tool.
With it you can create customized fringe patterns
and analyse them using phase shifting algorithms.

.. grid:: 2

    .. todo: make images smaller

    .. grid-item-card::
        :img-top: /images/getting_started.svg

        Getting Started
        ^^^^^^^^^^^^^^^

        New to *Fringes*? Check out the getting started guides.
        It contains an introduction to phase shifting,
        guides you through the installation process
        and gives examples of the most common use cases.

        +++

        .. button-ref:: 01_start/index
            :expand:
            :color: success
            :click-parent:

            To the getting started guide

    .. grid-item-card::
        :img-top: /images/user_guide.svg

        User Guide
        ^^^^^^^^^^

        The user guide provides in-depth information on the key concepts of *Fringes*
        with a detailed explanation of the key parameters.
        Performance related considerations are detailed here.

        +++

        .. button-ref:: 02_tutorial/index
            :expand:
            :color: success
            :click-parent:

            To the user guide

    .. grid-item-card::
        :img-top: /images/api.svg

        API Reference
        ^^^^^^^^^^^^^

        The reference guide contains a detailed description of the *Fringes* API.
        The reference describes how the methods work and which parameters can be used.
        It assumes that you have an understanding of the key concepts.

        +++

        .. button-ref:: 03_api/index
            :expand:
            :color: success
            :click-parent:

            To the reference guide


    .. grid-item-card::
        :img-top: /images/contributor.svg

        Contributor's Guide
        ^^^^^^^^^^^^^^^^^^^

        Saw a typo in the documentation?
        Want to improve existing functionalities?
        The contributing guidelines will guide you through the process of improving *Fringes*.

        +++

        .. button-ref:: 04_contribute/index
            :expand:
            :color: success
            :click-parent:

            To the contributor's guide

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`