| Name | peyes JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | A package for eye tracking data analysis and visualization |
| upload_time | 2024-08-18 15:37:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pEYES
## A Python Package for Eye-Tracking Researchers
This package is intended for scientific use when processing and analyzing eye-tracking data.
It provides easy-to-use functions for:
- Downloading & parsing publicly available annotated eye-tracking datasets.
- Configuring eye-tracking detection algorithms, and running them on the datasets or your own data.
- Analyzing the results of the detection algorithms, and comparing them to ground truth data or to a different detection algorithm.
- Visualizing the results of the detection algorithms.
## Installation Instructions
This package has been created and tested with python ```3.12```.
To install this package as a user, use
```angular2html
pip install peyes
```
To install this package as a developer, clone the package from GitHub and run the following commands:
```angular2html
python -m venv env
git pull
pip install -e .
git checkout -b dev
```
## Usage
This package is intended for scientific use, and is designed to be easy to use for anyone with basic python knowledge.
Most of the functions in this package are documented, and can be accessed by running:
```angular2html
import peyes
help(peyes)
```
For more detailed information, please refer to the user tutorials provided in the `docs` directory of this repository.
## Citation & License
This package is distributed under the MIT License, but some of the datasets & detection algorithms that are implemented
in this package are distributed under different licenses. Please refer to the documentation of the specific dataset or
detection algorithm for more information.
If you use this package in your research, please cite it as follows:
```angular2html
# TBD
```
If you use a specific dataset or detection algorithm that is implemented in this package, please also cite the original
authors of that dataset or detection algorithm. This information, like the license, can be found in the documentation
of the specific dataset or detection algorithm.
## Acknowledgements
We are grateful for the support of the [Center for Interdisciplinary Data Science Research (CIDR)](https://cidr.huji.ac.il/) at the [Hebrew University of Jerusalem](https://new.huji.ac.il/). In particular, we would like to thank Haimasree Bhattacharya from CIDR for her contributions.
Raw data
{
"_id": null,
"home_page": null,
"name": "peyes",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "\"Human Cognitive Neuroscience Lab @ HUJI\" <hcnl@mail.huji.ac.il>, Jonathan Nir <jonathan.nir@mail.huji.ac.il>",
"download_url": "https://files.pythonhosted.org/packages/fc/2a/93be3fe38a9e967d6f1b3fcc3ed4b0afe0b28ae7edee03fd74575b458195/peyes-0.0.8.tar.gz",
"platform": null,
"description": "# pEYES\n## A Python Package for Eye-Tracking Researchers\nThis package is intended for scientific use when processing and analyzing eye-tracking data. \nIt provides easy-to-use functions for:\n- Downloading & parsing publicly available annotated eye-tracking datasets.\n- Configuring eye-tracking detection algorithms, and running them on the datasets or your own data.\n- Analyzing the results of the detection algorithms, and comparing them to ground truth data or to a different detection algorithm.\n- Visualizing the results of the detection algorithms.\n\n## Installation Instructions\nThis package has been created and tested with python ```3.12```.\n\nTo install this package as a user, use\n```angular2html\npip install peyes\n```\nTo install this package as a developer, clone the package from GitHub and run the following commands:\n```angular2html\npython -m venv env\ngit pull\npip install -e .\ngit checkout -b dev\n```\n\n## Usage\nThis package is intended for scientific use, and is designed to be easy to use for anyone with basic python knowledge. \nMost of the functions in this package are documented, and can be accessed by running:\n```angular2html\nimport peyes\nhelp(peyes)\n```\nFor more detailed information, please refer to the user tutorials provided in the `docs` directory of this repository.\n\n## Citation & License\nThis package is distributed under the MIT License, but some of the datasets & detection algorithms that are implemented\nin this package are distributed under different licenses. Please refer to the documentation of the specific dataset or\ndetection algorithm for more information.\n\nIf you use this package in your research, please cite it as follows:\n```angular2html\n# TBD\n```\n\nIf you use a specific dataset or detection algorithm that is implemented in this package, please also cite the original\nauthors of that dataset or detection algorithm. This information, like the license, can be found in the documentation\nof the specific dataset or detection algorithm.\n\n## Acknowledgements\nWe are grateful for the support of the [Center for Interdisciplinary Data Science Research (CIDR)](https://cidr.huji.ac.il/) at the [Hebrew University of Jerusalem](https://new.huji.ac.il/). In particular, we would like to thank Haimasree Bhattacharya from CIDR for her contributions.\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for eye tracking data analysis and visualization",
"version": "0.0.8",
"project_urls": {
"Bug Tracker": "https://github.com/huji-hcnl/pEYES/issues",
"Homepage": "https://github.com/huji-hcnl/pEYES"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b98156996cce92fe367d9b0dd9451ac1a17e7ad61c0f098dbc0a05933a5bdaf9",
"md5": "d28944d0bfc796bc07db7ddea2d7e16f",
"sha256": "cda7d66ee6b434536452f1aaaecd1e083f01aba18d45173ce20b5f93439b580e"
},
"downloads": -1,
"filename": "peyes-0.0.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d28944d0bfc796bc07db7ddea2d7e16f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 79484,
"upload_time": "2024-08-18T15:37:31",
"upload_time_iso_8601": "2024-08-18T15:37:31.347988Z",
"url": "https://files.pythonhosted.org/packages/b9/81/56996cce92fe367d9b0dd9451ac1a17e7ad61c0f098dbc0a05933a5bdaf9/peyes-0.0.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc2a93be3fe38a9e967d6f1b3fcc3ed4b0afe0b28ae7edee03fd74575b458195",
"md5": "51adbdb876cfae74dfbd2031a2fcd242",
"sha256": "d791d20d8927e692e8b0ff190cf7b4b1f46ed12f82ad9463a1a9ec75b0909d39"
},
"downloads": -1,
"filename": "peyes-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "51adbdb876cfae74dfbd2031a2fcd242",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 231676,
"upload_time": "2024-08-18T15:37:33",
"upload_time_iso_8601": "2024-08-18T15:37:33.440236Z",
"url": "https://files.pythonhosted.org/packages/fc/2a/93be3fe38a9e967d6f1b3fcc3ed4b0afe0b28ae7edee03fd74575b458195/peyes-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 15:37:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "huji-hcnl",
"github_project": "pEYES",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "peyes"
}
