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: pymovements/pymovements

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

• Source code: pymovements/pymovements

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

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

• Bug reports: pymovements/pymovements#issues

• Contributing: pymovements/pymovements

• Mailing list: pymovements@python.org (subscribe)

• Discord: https://discord.gg/K2uS2R6PNj

Getting Started

With pymovements loading your eye movement datasets is just a few lines of code away

import pymovements as pm

dataset = pm.Dataset(
    'JuDo1000',  # choose a public dataset from our dataset library
    path='data/judo100',  # setup your local dataset path
)
dataset.download()  # download a public dataset from our dataset library
dataset.load()  # load the dataset

calculate velocities on the fly

dataset.pix2deg()  # transform pixel coordinates to degrees of visual angle
dataset.pos2vel()  # transform positional data to velocity data

and extract events with different eye movements event extraction algorithms

dataset.detect('ivt')  # detect fixation using the I-VT algorithm
dataset.detect('microsaccades')  # detect saccades using the microsaccades algorithm

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

We provide a range of tutorials 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 to us at pymovements@python.org

Citing

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

@inproceedings{pymovements,
    author = {Krakowczyk, Daniel G. and Reich, David R. and Chwastek, Jakob and Jakobi, Deborah N.
 and Prasse, Paul and Süss, Assunta and Turuta, Oleksii and Kasprowski, Paweł
 and Jäger, Lena A.},
    title = {pymovements: A Python Package for Processing Eye Movement Data},
    year = {2023},
    isbn = {979-8-4007-0150-4/23/05},
    publisher = {Association for Computing Machinery},
    address = {New York, NY, USA},
    url = {https://doi.org/10.1145/3588015.3590134},
    doi = {10.1145/3588015.3590134},
    booktitle = {2023 Symposium on Eye Tracking Research and Applications},
    location = {Tubingen, Germany},
    series = {ETRA '23},
}

There is also a preprint available on arxiv.