PyNeon documentation#
+Welcome to PyNeon documentation#
PyNeon is a light-weight library to work with Neon (Pupil Labs) multi-modal -eye-tracking data. It is originally developed by Qian Chu and Jan-Gabriel -Hartel from the Max Planck Institute for Empirical Aesthetics.
+eye-tracking data. It is a community-driven effort to provide a versatile set +of tools to work with the rich data (gaze, eye states, IMU, events, etc.) +provided by Neon. +PyNeon is licensed under the MIT License.
+Here we provide tutorials and API reference to help you get started with PyNeon.
Installation#
@@ -340,6 +346,10 @@Data format
+Credits#
+PyNeon was inspired by pupil-labs/pl-neon-recording
PyNeon Tutorials#
+Here you can find tutorials in the form of Jupyter notebooks to help you get +started with PyNeon.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tutorials/load_dataset.ipynb b/docs/tutorials/load_dataset.ipynb
new file mode 100644
index 0000000..35a9f40
--- /dev/null
+++ b/docs/tutorials/load_dataset.ipynb
@@ -0,0 +1,30 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Load a Neon dataset\n",
+ "In this tutorial, we will show how to load a Neon dataset downloaded from [Pupil Cloud](https://docs.pupil-labs.com/neon/pupil-cloud/)."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "vscode": {
+ "languageId": "plaintext"
+ }
+ },
+ "outputs": [],
+ "source": []
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/tutorials/load_recording.html b/docs/tutorials/load_recording.html
new file mode 100644
index 0000000..781f4ce
--- /dev/null
+++ b/docs/tutorials/load_recording.html
@@ -0,0 +1,490 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Load a Neon dataset (Pupil Cloud project)#
+In this tutorial, we will show how to load a Neon dataset downloaded from Pupil Cloud.
+
+
+
+
+
+
+[ ]:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tutorials/load_recording.ipynb b/docs/tutorials/load_recording.ipynb
new file mode 100644
index 0000000..90e463a
--- /dev/null
+++ b/docs/tutorials/load_recording.ipynb
@@ -0,0 +1,26 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Load a Neon recording\n",
+ "In this tutorial, we will show how to load a single Neon recording downloaded from [Pupil Cloud](https://docs.pupil-labs.com/neon/pupil-cloud/)."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": []
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/tutorials/resample_and_concat.html b/docs/tutorials/resample_and_concat.html
new file mode 100644
index 0000000..5b20f48
--- /dev/null
+++ b/docs/tutorials/resample_and_concat.html
@@ -0,0 +1,480 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Load a Neon recording#
+In this tutorial, we will show how to load a single Neon recording downloaded from Pupil Cloud.
+
+
+
+
+
+
+[ ]:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tutorials/resample_and_concat.ipynb b/docs/tutorials/resample_and_concat.ipynb
new file mode 100644
index 0000000..375b925
--- /dev/null
+++ b/docs/tutorials/resample_and_concat.ipynb
@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Resample data and concatenate channels\n"
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/source/conf.py b/source/conf.py
index 50d353c..94c21a5 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -24,7 +24,7 @@
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
intersphinx_mapping = {
- 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
+ "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
}
# -- Options for HTML output -------------------------------------------------
diff --git a/source/index.rst b/source/index.rst
index cc49de9..e4cdf65 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -2,12 +2,17 @@
.. module:: pyneon
-PyNeon documentation
-====================
+Welcome to PyNeon documentation
+===============================
PyNeon is a light-weight library to work with Neon (Pupil Labs) multi-modal
-eye-tracking data. It is originally developed by Qian Chu and Jan-Gabriel
-Hartel from the Max Planck Institute for Empirical Aesthetics.
+eye-tracking data. It is a community-driven effort to provide a versatile set
+of tools to work with the rich data (gaze, eye states, IMU, events, etc.)
+provided by Neon.
+
+PyNeon is licensed under the MIT License.
+
+Here we provide tutorials and API reference to help you get started with PyNeon.
Installation
============
@@ -28,6 +33,11 @@ PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" forma
as exported from Pupil Clouds. The data could be from a single recording or from a
project with multiple recordings.
+Credits
+=======
+
+PyNeon was inspired by https://github.com/pupil-labs/pl-neon-recording/
+
.. toctree::
:maxdepth: 1
:hidden:
diff --git a/source/tutorials/export_to_bids.ipynb b/source/tutorials/export_to_bids.ipynb
new file mode 100644
index 0000000..5f33234
--- /dev/null
+++ b/source/tutorials/export_to_bids.ipynb
@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Export Neon data recording to BIDS formats\n"
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/source/tutorials/index.rst b/source/tutorials/index.rst
index f549875..e74a60e 100644
--- a/source/tutorials/index.rst
+++ b/source/tutorials/index.rst
@@ -3,8 +3,13 @@
PyNeon Tutorials
================
+Here you can find tutorials in the form of Jupyter notebooks to help you get
+started with PyNeon.
+
.. toctree::
:maxdepth: 1
load_recording
- load_dataset
\ No newline at end of file
+ load_dataset
+ resample_and_concat
+ export_to_bids
\ No newline at end of file
diff --git a/source/tutorials/load_dataset.ipynb b/source/tutorials/load_dataset.ipynb
index 35a9f40..6f2a872 100644
--- a/source/tutorials/load_dataset.ipynb
+++ b/source/tutorials/load_dataset.ipynb
@@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "# Load a Neon dataset\n",
+ "# Load a Neon dataset (Pupil Cloud project)\n",
"In this tutorial, we will show how to load a Neon dataset downloaded from [Pupil Cloud](https://docs.pupil-labs.com/neon/pupil-cloud/)."
]
},
diff --git a/source/tutorials/resample_and_concat.ipynb b/source/tutorials/resample_and_concat.ipynb
new file mode 100644
index 0000000..375b925
--- /dev/null
+++ b/source/tutorials/resample_and_concat.ipynb
@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Resample data and concatenate channels\n"
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+