.. PyPlr documentation master file, created by
sphinx-quickstart on Wed Feb 10 20:19:35 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to *PyPlr*'s documentation!
===================================
|Contributor Covenant| |DOI| |PyPI version| |PyPi license|
*PyPlr* is a Python library for researching the pupillary light reflex
with the `Pupil Core `__ eye
tracking platform. See also, `PySilSub `_,
a sister project offering Python support for the method of silent substitution.
*PyPlr's* features include:
- User-friendly and feature-rich interfaces to:
- Pupil Core (Pupil Labs GmbH, Berlin, Germany)
- Spectra Tune Lab (STLAB: LEDMOTIVE Technologies, LLC, Barcelona, Spain) light engine
- Ocean Optics (Ocean Insight Inc., Oxford, UK) spectrometers
- Flexible support for alternative stimulus delivery and measurement
systems
- Scripting tools to facilitate stimulus design, optimisation and
delivery, communication with respect to timing, and extraction,
cleaning, and analysis of pupil data
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg
:target: https://github.com/PyPlr/cvd_pupillometry/blob/master/CODE_OF_CONDUCT.md
.. |DOI| image:: https://zenodo.org/badge/249983560.svg
:target: https://zenodo.org/badge/latestdoi/249983560
.. |PyPI version| image:: https://badge.fury.io/py/pyplr.svg
:target: https://badge.fury.io/py/pyplr
.. |PyPi license| image:: https://badgen.net/pypi/license/pip/
:target: https://github.com/PyPlr/cvd_pupillometry/blob/master/LICENSE.txt
.. toctree::
:maxdepth: 2
:caption: Contents:
01_includeme
02_purpose
03_installation
04_overview
05_example_protocols
06_example_analyses
07_api
08_developers
09_acknowledgements
10_funding
11_citation
.. rubric:: Tables and indices
------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`