pymovements

A python package for processing eye movement data

https://github.com/aeye-lab/pymovements

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
    2 of 15 committers (13.3%) from academic institutions
  • Institutional organization owner
    Organization aeye-lab has institutional domain (www.uni-potsdam.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary

Keywords

event-detection eye-tracking eyetracking python scientific-computing scientific-software scientific-visualization

Keywords from Contributors

interpretability energy-system-model mesh profiles hydrology medical-imaging regionalization energy-system exoplanet standardization
Last synced: 6 months ago · JSON representation ·

Repository

A python package for processing eye movement data

Basic Info
Statistics
  • Stars: 110
  • Watchers: 4
  • Forks: 38
  • Open Issues: 228
  • Releases: 45
Topics
event-detection eye-tracking eyetracking python scientific-computing scientific-software scientific-visualization
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation Codeowners

README.md

pymovements


PyPI Latest Release Conda Latest Release PyPI status Python version Operating System License Test Status Documentation Status codecov PyPI Downloads Binder

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: https://github.com/aeye-lab/pymovements
  • Documentation: https://pymovements.readthedocs.io
  • Source code: https://github.com/aeye-lab/pymovements
  • PyPI package: https://pypi.org/project/pymovements
  • Conda package: https://anaconda.org/conda-forge/pymovements
  • Bug reports: https://github.com/aeye-lab/pymovements/issues
  • Contributing: https://github.com/aeye-lab/pymovements/blob/main/CONTRIBUTING.md
  • 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

```python 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

python 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

python 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 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@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:

bibtex @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.

Owner

  • Name: AEye
  • Login: aeye-lab
  • Kind: organization
  • Email: lejaeger@uni-potsdam.de

AEye is a junior research group within the University of Potsdam. Members of AEye work on the intersection of machine learning and eye tracking.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
preferred-citation:
  authors:
  - family-names: "Krakowczyk"
    given-names: "Daniel G."
  - family-names: "Reich"
    given-names: "David R."
  - family-names: "Chwastek"
    given-names: "Jakob"
  - family-names: "Jakobi"
    given-names: "Deborah N."
  - family-names: "Prasse"
    given-names: "Paul"
  - family-names: "Süss"
    given-names: "Assunta"
  - family-names: "Turuta"
    given-names: "Oleksii"
  - family-names: "Kasprowski"
    given-names: "Paweł"
  - family-names: "Jäger"
    given-names: "Lena A."
  title: "pymovements: A Python Package for Processing Eye Movement Data"
  version: 0.18.0
  type: conference-paper
  doi: 10.1145/3588015.3590134
  url: "https://doi.org/10.1145/3588015.3590134"
  year: 2023
  collection-type: proceedings
  collection-title: "2023 Symposium on Eye Tracking Research and Applications"
  collection-location: "Tubingen, Germany"
  collection-series: "ETRA '23"
  publisher:
    name: "Association for Computing Machinery"
    address: New York, NY, USA
  isbn: "979-8-4007-0150-4/23/05"

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 442
  • Total Committers: 15
  • Avg Commits per committer: 29.467
  • Development Distribution Score (DDS): 0.303
Past Year
  • Commits: 380
  • Committers: 15
  • Avg Commits per committer: 25.333
  • Development Distribution Score (DDS): 0.329
Top Committers
Name Email Commits
Daniel Krakowczyk d****k@u****e 308
David R. Reich 4****e 43
pre-commit-ci[bot] 6****] 33
Jakob Chwastek j****k@g****m 16
prassepaul p****l@g****m 13
dependabot[bot] 4****] 9
Deborah N. Jakobi 5****r 8
siqube-adobe 1****e 3
Jakob Chwastek c****k@u****e 2
Josephine Funken 1****n 2
Patrick Haller p****r@g****m 1
Bartłomiej Krawisz 4****3 1
David R. Reich 4****e 1
Shuwen27 7****7 1
assuntasuess 1****s 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 290
  • Total pull requests: 496
  • Average time to close issues: 3 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 15
  • Total pull request authors: 31
  • Average comments per issue: 0.73
  • Average comments per pull request: 1.45
  • Merged pull requests: 376
  • Bot issues: 0
  • Bot pull requests: 107
Past Year
  • Issues: 95
  • Pull requests: 204
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 14 days
  • Issue authors: 12
  • Pull request authors: 27
  • Average comments per issue: 0.92
  • Average comments per pull request: 1.29
  • Merged pull requests: 123
  • Bot issues: 0
  • Bot pull requests: 34
Top Authors
Issue Authors
  • dkrako (209)
  • SiQube (38)
  • saeub (19)
  • xiaotiansu (8)
  • jakobchwastek (5)
  • izaskr (4)
  • AnnaBhlr (2)
  • saphjra (2)
  • annabondar3 (1)
  • MaxistheSpy (1)
  • romajaku (1)
  • ivanvajs1996 (1)
  • nisar2 (1)
  • cbueth (1)
  • OmerShubi (1)
Pull Request Authors
  • dkrako (229)
  • SiQube (161)
  • dependabot[bot] (78)
  • pre-commit-ci[bot] (78)
  • saeub (30)
  • jakobchwastek (14)
  • prassepaul (14)
  • josephine-funken (10)
  • theDebbister (8)
  • OmerShubi (5)
  • kasprowski (5)
  • cbueth (3)
  • siqube-adobe (3)
  • bujkani (3)
  • xiaotiansu (2)
Top Labels
Issue Labels
enhancement (208) bug (48) good first issue (31) essential (20) documentation (16) dataset (12) nonessential (8) plotting (2) question (2) internal (2) parsing (2) fix (2) breaking (1) wontfix (1) performance (1) help wanted (1)
Pull Request Labels
internal (115) dependencies (78) build (78) enhancement (76) documentation (51) fix (40) python (16) dataset (12) deprecation (11) breaking (9) bug (5) essential (2) highlight (2) urgent (2) docs (1) performance (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 3,110 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 44
  • Total maintainers: 1
pypi.org: pymovements

A python package for processing eye movement data

  • Versions: 44
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 3,110 Last month
Rankings
Dependent packages count: 10.1%
Downloads: 10.2%
Stargazers count: 11.5%
Average: 13.7%
Forks count: 15.4%
Dependent repos count: 21.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • numpy >=1.10.0
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • codecov/codecov-action v3 composite
  • r-lib/actions/setup-pandoc v2 composite
pyproject.toml pypi
  • matplotlib >=3.0.0,<3.8
  • numpy >=1.10.0,<2
  • pandas >1.0.0,<3
  • polars >=0.19.0,<0.20.0
  • pyarrow >=11.0.0,<14
  • scipy >=1.5.4,<2
  • tqdm >=4.0.0,<5
.github/workflows/autolabeler.yml actions
  • release-drafter/release-drafter v5 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish master composite