Getting started
===============

New to :mod:`pypillometry`? Install the package, then work through the
quickstart. It takes you from a raw recording to an event-related pupil
response in about ten minutes.

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

   .. grid-item-card:: :fas:`download` Installation
      :link: installation
      :link-type: doc

      Install from PyPI or GitHub and set up the optional parts.

   .. grid-item-card:: :fas:`rocket` Quickstart
      :link: quickstart
      :link-type: doc

      Load data, handle blinks, filter, and look at event-related pupil
      dilations.

   .. grid-item-card:: :fas:`terminal` Command-line tools
      :link: cli
      :link-type: doc

      Look at and convert recordings without writing any code.

After the quickstart, the :doc:`/user_guide/index` explains the concepts in
more depth and the :doc:`/tutorials/index` show complete analyses.

.. toctree::
   :hidden:

   installation
   quickstart
   cli