:notoc:

.. dreye documentation master file, created by

.. module:: dreye

**************************************************************
DrEye - Exploiting Receptor Space Geometry for Stimulus Design
**************************************************************

**Date**: |today| **Version**: |version|

**Useful links**:
`Binary Installers <https://pypi.org/project/dreye>`__ |
`Source Repository <https://github.com/gucky92/dreye>`__ |
`Issues & Ideas <https://github.com/gucky92/dreye/issues>`__

:mod:`dreye` is an open source, MIT-licensed library.
For creating the documentation for :mod:`dreye`, I used pandas documentation style.

Our preprint that explains the purpose of the package *drEye* and goes through key concepts is available on `bioRxiv <https://www.biorxiv.org/content/10.1101/2022.01.17.476640v1>`__. 
Please reference this preprint when using *drEye*.

.. raw:: html

    <div class="container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <img src="_static/index_user_guide.svg" class="card-img-top" alt="user guide for dreye action icon" height="52">
                <div class="card-body flex-fill">
                    <h5 class="card-title">User Guide</h5>
                    <p class="card-text">New to <em>dreye</em>? Check out the user guide. It
                    contains installation instructions, an introduction to
                    <em>dreye's</em> main concepts and tutorials.</p>

.. container:: custom-button

    :ref:`User Guide<user_guide>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <img src="_static/index_api.svg" class="card-img-top" alt="api of dreye action icon" height="52">
                <div class="card-body flex-fill">
                    <h5 class="card-title">API reference</h5>
                    <p class="card-text">The reference guide contains a detailed description of
                    the dreye 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.</p>

.. container:: custom-button

    :ref:`To the reference guide<api>`

.. raw:: html

                </div>
                </div>
            </div>
        </div>
    </div>


.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:


    user_guide/index
    reference/index
    development/index
    whatsnew/index