add more tutorials

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d7d1e277d5650e23848c2f7b1e30761e
+config: a3337b8fdb7d16f69d6f92f1c6fc4a2c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/index.rst.txt

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

docs/_sources/tutorials/export_to_bids.ipynb.txt

@@ -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
+}

docs/_sources/tutorials/index.rst.txt

@@ -3,3 +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
+    resample_and_concat
+    export_to_bids

docs/_sources/tutorials/load_dataset.ipynb.txt

@@ -0,0 +1,30 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# 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/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/_sources/tutorials/load_recording.ipynb.txt

@@ -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
+}

docs/_sources/tutorials/resample_and_concat.ipynb.txt

@@ -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
+}