=====================
PyroLab Documentation
=====================

A framework for using remote lab instruments as local resources, built on `Pyro5`_.

.. image:: ./_static/images/pyrolab_logo.svg
   :width: 300
   :align: center

.. _Pyro5: https://pyro5.readthedocs.io/en/latest/

Key Features
------------

- Free and open-source software provided under the GPLv3+ License.
- Compatible with Python 3.7+.
- Cross-platform: runs on Windows, MacOS, and Linux.
- Included device drivers for several scopes and ThorLabs motion controllers.
- Remotely controlled devices can be accessed through a `Pyro5`_ proxy.

If you use PyroLab, we'd appreciate you citing our work:


.. tab-set::

    .. tab-item:: Text

        Coming soon

    .. tab-item:: BibTeX

        .. code-block:: 

            Coming soon


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

    .. grid-item-card::  Getting Started

        .. image:: /_static/images/index_getting_started.svg
            :align: center
            :height: 100
            :width: 100

        New to *PyroLab*? Check out the getting started guides. They contain an
        introduction to *PyroLab's* main concepts and a step-by-step tutorial for
        beginners.

        .. button-ref:: getting_started
            :color: primary
            :shadow:
            :expand:

            To the getting started guides

    .. grid-item-card::  User Guide

        .. image:: /_static/images/index_user_guide.svg
            :align: center
            :height: 100
            :width: 100

        The user guide provides in-depth information on the key concepts of PyroLab
        with useful background information and explanation.

        .. button-ref:: user_guide
            :color: primary
            :shadow:
            :expand:

            To the user guide

    .. grid-item-card::  API Reference

        .. image:: /_static/images/index_api.svg
            :align: center
            :height: 100
            :width: 100

        The reference guide contains a detailed description of the PyroLab API. The
        reference describes how the methods work and which parameters can be used.
        It also contains a listing of provided hardware drivers. It assumes that
        you have an understanding of the key concepts.

        .. button-ref:: api_reference
            :color: primary
            :shadow:
            :expand:

            To the reference guide

    .. grid-item-card::  Developer Guide

        .. image:: /_static/images/index_contribute.svg
            :align: center
            :height: 100
            :width: 100

        Want to add your own device driver? Saw a typo in the documentation? Want to improve
        existing functionalities? The contributing guidelines will guide
        you through the process of improving PyroLab.

        .. button-ref:: development
            :color: primary
            :shadow:
            :expand:

            To the development guide


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

   getting_started/index
   user_guide/index
   reference/index
   development/index