Welcome to the pymovements documentation!

---

pymovements is an open-source python package for processing eye movement data. It provides a simple interface to download publicly available datasets, preprocess gaze data, detect oculomotoric events and render plots to visually analyze your results.

• Website: aeye-lab/pymovements

• Documentation: https://pymovements.readthedocs.io

• Source code: aeye-lab/pymovements

• Mailing list: pymovements-list@uni-potsdam.de

• Contributing: aeye-lab/pymovements

• Bug reports: aeye-lab/pymovements#issues

• PyPI package: https://pypi.org/project/pymovements

• Conda package: https://anaconda.org/conda-forge/pymovements

Getting Started

Check out our guide on how to install pymovements and get started here: Installation

We provide a range of tutorial aimed at beginners: Tutorials

The complete reference of the package can be found here: API Reference

Contributing

We welcome any sort of contribution to pymovements!

For a detailed guide, please refer to our CONTRIBUTING.md first.

If you have any questions, please open an issue or write us at pymovements-list@uni-potsdam.de

Citing

If you are using pymovements in your research, we would be happy if you cite our work by using the following BibTex entry:

@misc{pymovements,
  author = {Krakowczyk, Daniel G. and Reich, David R. and Chwastek, Jakob and Süss, Assunta
   and Prasse, Paul and Jakobi, Deborah N. and Turuta, Oleksii and Kasprowski, Paweł
   and Jäger, Lena A.},
  title = {pymovements: A Python Package for Processing Eye Movement Data},
  year = {2023},
  publisher = {GitHub},
  howpublished = {\url{https://github.com/aeye-lab/pymovements}},
}