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

Installation#

Using pip#

pymovements can be installed directly from the PyPI repositories:

pip install pymovements

Using conda#

pymovements can be installed from the conda-forge repositories.

If not already done, you will need to add conda-forge to your available channels:

conda config --add channels conda-forge
conda config --set channel_priority strict

You can then install pymovements into you conda environment:

conda install -c conda-forge pymovements

Development installation#

To use the latest development version or to try out tutorials, pymovements may be alternatively cloned and installed with

git clone https://github.com/aeye-lab/pymovements.git
pip install -e ./pymovements

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 and Reich, David R. and Chwastek, Jakob, Prasse, Paul and Jäger, Lena},
  title = {pymovements: A Python Package for Processing Eye Movement Data},
  year = {2023},
  publisher = {GitHub},
  howpublished = {\url{https://github.com/aeye-lab/pymovements}},
}