diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 8024dbf..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,32 +0,0 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Set the OS, Python version and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.12" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" - -# Build documentation in the "docs/" directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/Makefile b/Makefile similarity index 92% rename from docs/Makefile rename to Makefile index d4bb2cb..d0c3cbf 100644 --- a/docs/Makefile +++ b/Makefile @@ -5,8 +5,8 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build +SOURCEDIR = source +BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/_build/html/.buildinfo b/doc/.buildinfo similarity index 100% rename from docs/_build/html/.buildinfo rename to doc/.buildinfo diff --git a/docs/_build/html/_sources/index.rst.txt b/doc/_sources/index.rst.txt similarity index 71% rename from docs/_build/html/_sources/index.rst.txt rename to doc/_sources/index.rst.txt index 11cfb0c..cc49de9 100644 --- a/docs/_build/html/_sources/index.rst.txt +++ b/doc/_sources/index.rst.txt @@ -13,7 +13,7 @@ Installation ============ To install PyNeon, clone the PyNeon repository from -https://github.com/NCCLabMPI/pyneon and run: +https://github.com/NCCLabMPI/PyNeon and run: .. code-block:: bash @@ -24,7 +24,9 @@ PyPI and conda releases are planned for the future. Data format =========== -PyNeon works with the "Timeseries" data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings. +PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" formats +as exported from Pupil Clouds. The data could be from a single recording or from a +project with multiple recordings. .. toctree:: :maxdepth: 1 diff --git a/docs/_build/html/_sources/reference/dataset.rst.txt b/doc/_sources/reference/dataset.rst.txt similarity index 100% rename from docs/_build/html/_sources/reference/dataset.rst.txt rename to doc/_sources/reference/dataset.rst.txt diff --git a/docs/_build/html/_sources/reference/index.rst.txt b/doc/_sources/reference/index.rst.txt similarity index 100% rename from docs/_build/html/_sources/reference/index.rst.txt rename to doc/_sources/reference/index.rst.txt diff --git a/docs/_build/html/_sources/reference/preprocess.rst.txt b/doc/_sources/reference/preprocess.rst.txt similarity index 100% rename from docs/_build/html/_sources/reference/preprocess.rst.txt rename to doc/_sources/reference/preprocess.rst.txt diff --git a/docs/_build/html/_sources/reference/recording.rst.txt b/doc/_sources/reference/recording.rst.txt similarity index 100% rename from docs/_build/html/_sources/reference/recording.rst.txt rename to doc/_sources/reference/recording.rst.txt diff --git a/docs/_build/html/_sources/tutorials/index.rst.txt b/doc/_sources/tutorials/index.rst.txt similarity index 100% rename from docs/_build/html/_sources/tutorials/index.rst.txt rename to doc/_sources/tutorials/index.rst.txt diff --git a/docs/_build/html/_static/basic.css b/doc/_static/basic.css similarity index 100% rename from docs/_build/html/_static/basic.css rename to doc/_static/basic.css diff --git a/docs/_build/html/_static/doctools.js b/doc/_static/doctools.js similarity index 100% rename from docs/_build/html/_static/doctools.js rename to doc/_static/doctools.js diff --git a/docs/_build/html/_static/documentation_options.js b/doc/_static/documentation_options.js similarity index 100% rename from docs/_build/html/_static/documentation_options.js rename to doc/_static/documentation_options.js diff --git a/docs/_build/html/_static/file.png b/doc/_static/file.png similarity index 100% rename from docs/_build/html/_static/file.png rename to doc/_static/file.png diff --git a/docs/_build/html/_static/language_data.js b/doc/_static/language_data.js similarity index 100% rename from docs/_build/html/_static/language_data.js rename to doc/_static/language_data.js diff --git a/docs/_build/html/_static/minus.png b/doc/_static/minus.png similarity index 100% rename from docs/_build/html/_static/minus.png rename to doc/_static/minus.png diff --git a/docs/_build/html/_static/plus.png b/doc/_static/plus.png similarity index 100% rename from docs/_build/html/_static/plus.png rename to doc/_static/plus.png diff --git a/docs/_build/html/_static/pygments.css b/doc/_static/pygments.css similarity index 100% rename from docs/_build/html/_static/pygments.css rename to doc/_static/pygments.css diff --git a/docs/_build/html/_static/scripts/bootstrap.js b/doc/_static/scripts/bootstrap.js similarity index 100% rename from docs/_build/html/_static/scripts/bootstrap.js rename to doc/_static/scripts/bootstrap.js diff --git a/docs/_build/html/_static/scripts/bootstrap.js.LICENSE.txt b/doc/_static/scripts/bootstrap.js.LICENSE.txt similarity index 100% rename from docs/_build/html/_static/scripts/bootstrap.js.LICENSE.txt rename to doc/_static/scripts/bootstrap.js.LICENSE.txt diff --git a/docs/_build/html/_static/scripts/bootstrap.js.map b/doc/_static/scripts/bootstrap.js.map similarity index 100% rename from docs/_build/html/_static/scripts/bootstrap.js.map rename to doc/_static/scripts/bootstrap.js.map diff --git a/docs/_build/html/_static/scripts/pydata-sphinx-theme.js b/doc/_static/scripts/pydata-sphinx-theme.js similarity index 100% rename from docs/_build/html/_static/scripts/pydata-sphinx-theme.js rename to doc/_static/scripts/pydata-sphinx-theme.js diff --git a/docs/_build/html/_static/scripts/pydata-sphinx-theme.js.map b/doc/_static/scripts/pydata-sphinx-theme.js.map similarity index 100% rename from docs/_build/html/_static/scripts/pydata-sphinx-theme.js.map rename to doc/_static/scripts/pydata-sphinx-theme.js.map diff --git a/docs/_build/html/_static/searchtools.js b/doc/_static/searchtools.js similarity index 100% rename from docs/_build/html/_static/searchtools.js rename to doc/_static/searchtools.js diff --git a/docs/_build/html/_static/sphinx_highlight.js b/doc/_static/sphinx_highlight.js similarity index 100% rename from docs/_build/html/_static/sphinx_highlight.js rename to doc/_static/sphinx_highlight.js diff --git a/docs/_build/html/_static/styles/bootstrap.css b/doc/_static/styles/bootstrap.css similarity index 100% rename from docs/_build/html/_static/styles/bootstrap.css rename to doc/_static/styles/bootstrap.css diff --git a/docs/_build/html/_static/styles/bootstrap.css.map b/doc/_static/styles/bootstrap.css.map similarity index 100% rename from docs/_build/html/_static/styles/bootstrap.css.map rename to doc/_static/styles/bootstrap.css.map diff --git a/docs/_build/html/_static/styles/pydata-sphinx-theme.css b/doc/_static/styles/pydata-sphinx-theme.css similarity index 100% rename from docs/_build/html/_static/styles/pydata-sphinx-theme.css rename to doc/_static/styles/pydata-sphinx-theme.css diff --git a/docs/_build/html/_static/styles/pydata-sphinx-theme.css.map b/doc/_static/styles/pydata-sphinx-theme.css.map similarity index 100% rename from docs/_build/html/_static/styles/pydata-sphinx-theme.css.map rename to doc/_static/styles/pydata-sphinx-theme.css.map diff --git a/docs/_build/html/_static/styles/theme.css b/doc/_static/styles/theme.css similarity index 100% rename from docs/_build/html/_static/styles/theme.css rename to doc/_static/styles/theme.css diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/LICENSE.txt b/doc/_static/vendor/fontawesome/6.5.2/LICENSE.txt similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/LICENSE.txt rename to doc/_static/vendor/fontawesome/6.5.2/LICENSE.txt diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/css/all.min.css b/doc/_static/vendor/fontawesome/6.5.2/css/all.min.css similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/css/all.min.css rename to doc/_static/vendor/fontawesome/6.5.2/css/all.min.css diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/js/all.min.js b/doc/_static/vendor/fontawesome/6.5.2/js/all.min.js similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/js/all.min.js rename to doc/_static/vendor/fontawesome/6.5.2/js/all.min.js diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt b/doc/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt rename to doc/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf diff --git a/docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 b/doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 similarity index 100% rename from docs/_build/html/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 rename to doc/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 diff --git a/docs/_build/html/_static/webpack-macros.html b/doc/_static/webpack-macros.html similarity index 100% rename from docs/_build/html/_static/webpack-macros.html rename to doc/_static/webpack-macros.html diff --git a/docs/_build/html/genindex.html b/doc/genindex.html similarity index 100% rename from docs/_build/html/genindex.html rename to doc/genindex.html diff --git a/docs/_build/html/index.html b/doc/index.html similarity index 97% rename from docs/_build/html/index.html rename to doc/index.html index 39e5b64..be0e260 100644 --- a/docs/_build/html/index.html +++ b/doc/index.html @@ -329,7 +329,7 @@

Installation#

To install PyNeon, clone the PyNeon repository from -NCCLabMPI/pyneon and run:

+NCCLabMPI/PyNeon and run:

pip install .
 
@@ -337,7 +337,9 @@

Installation

Data format#

-

PyNeon works with the “Timeseries” data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings.

+

PyNeon works with the “Timeseries Data” or “Timeseries Data + Scene Video” formats +as exported from Pupil Clouds. The data could be from a single recording or from a +project with multiple recordings.

diff --git a/docs/_build/html/objects.inv b/doc/objects.inv similarity index 100% rename from docs/_build/html/objects.inv rename to doc/objects.inv diff --git a/docs/_build/html/py-modindex.html b/doc/py-modindex.html similarity index 100% rename from docs/_build/html/py-modindex.html rename to doc/py-modindex.html diff --git a/docs/_build/html/reference/dataset.html b/doc/reference/dataset.html similarity index 100% rename from docs/_build/html/reference/dataset.html rename to doc/reference/dataset.html diff --git a/docs/_build/html/reference/index.html b/doc/reference/index.html similarity index 100% rename from docs/_build/html/reference/index.html rename to doc/reference/index.html diff --git a/docs/_build/html/reference/preprocess.html b/doc/reference/preprocess.html similarity index 100% rename from docs/_build/html/reference/preprocess.html rename to doc/reference/preprocess.html diff --git a/docs/_build/html/reference/recording.html b/doc/reference/recording.html similarity index 98% rename from docs/_build/html/reference/recording.html rename to doc/reference/recording.html index 45eb5a3..abc8098 100644 --- a/docs/_build/html/reference/recording.html +++ b/doc/reference/recording.html @@ -412,6 +412,12 @@

pyneon.NeonRecording

resamp_other_kind (str, optional) – Resampling method for columns of other types, by default “nearest”.

+
Returns:
+

concat_data – Concatenated data.

+
+
Return type:
+

pd.DataFrame

+
diff --git a/docs/_build/html/search.html b/doc/search.html similarity index 100% rename from docs/_build/html/search.html rename to doc/search.html diff --git a/doc/searchindex.js b/doc/searchindex.js new file mode 100644 index 0000000..8a8c483 --- /dev/null +++ b/doc/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Data format": [[0, "data-format"]], "Installation": [[0, "installation"]], "PyNeon API": [[2, null]], "PyNeon Tutorials": [[5, null]], "PyNeon documentation": [[0, null]], "pyneon.NeonDataset": [[1, null]], "pyneon.NeonRecording": [[4, null]], "pyneon.preprocess": [[3, null]]}, "docnames": ["index", "reference/dataset", "reference/index", "reference/preprocess", "reference/recording", "tutorials/index"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "reference\\dataset.rst", "reference\\index.rst", "reference\\preprocess.rst", "reference\\recording.rst", "tutorials\\index.rst"], "indexentries": {"concat_channels() (pyneon.neonrecording method)": [[4, "pyneon.NeonRecording.concat_channels", false]], "eye_states (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.eye_states", false]], "gaze (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.gaze", false]], "imu (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.imu", false]], "module": [[0, "module-pyneon", false]], "neonrecording (class in pyneon)": [[4, "pyneon.NeonRecording", false]], "pyneon": [[0, "module-pyneon", false]]}, "objects": {"": [[0, 0, 0, "-", "pyneon"]], "pyneon": [[1, 1, 1, "", "NeonDataset"], [4, 1, 1, "", "NeonRecording"], [3, 0, 0, "-", "preprocess"]], "pyneon.NeonRecording": [[4, 2, 1, "", "concat_channels"], [4, 3, 1, "", "eye_states"], [4, 3, 1, "", "gaze"], [4, 3, 1, "", "imu"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property"}, "terms": {"3d": 4, "3d_eye_st": 4, "It": 0, "The": 0, "These": 4, "To": 0, "access": 4, "aesthet": 0, "all": 4, "alreadi": 4, "ar": [0, 4], "attribut": 4, "bool": 4, "can": 4, "ch_name": 4, "channel": 4, "chu": 0, "class": [1, 2, 4], "clone": 0, "cloud": 0, "column": 4, "common": 4, "concat_channel": 4, "concat_data": 4, "concaten": 4, "conda": 0, "could": 0, "data": 4, "datafram": 4, "dataset_dir": 1, "default": 4, "detail": 4, "develop": 0, "downsampl": 4, "empir": 0, "export": 0, "ey": [0, 4], "eye_st": 4, "first": 4, "float": 4, "from": [0, 4], "function": 2, "futur": 0, "gabriel": 0, "gaze": 4, "hartel": 0, "i": [0, 2, 4], "imu": 4, "institut": 0, "interpol": 4, "jan": 0, "lab": 0, "lazili": 4, "librari": 0, "light": 0, "linear": 4, "list": 4, "load": 4, "max": 0, "mean": 4, "method": 4, "modal": [0, 4], "more": 4, "multi": 0, "multipl": [0, 1], "name": 4, "ncclabmpi": 0, "nearest": 4, "neon": 0, "neoneyest": 4, "neongaz": 4, "neonimu": 4, "object": [1, 4], "one": 4, "onli": 4, "option": 4, "origin": 0, "other": 4, "paramet": 4, "path": [1, 4], "pd": 4, "pip": 0, "plan": 0, "planck": 0, "preprocess": 4, "project": 0, "properti": 4, "pupil": 0, "pypi": 0, "qian": 0, "record": [0, 1, 4], "recording_dir": 4, "referencc": 2, "releas": 0, "repositori": 0, "requir": 4, "resamp_float_kind": 4, "resamp_other_kind": 4, "resampl": 4, "return": 4, "run": 0, "same": 4, "scene": 0, "see": 4, "signal": 4, "singl": [0, 4], "specif": 4, "state": 4, "str": [1, 4], "thi": [2, 4], "time": 4, "timeseri": 0, "timestamp": 4, "track": 0, "true": 4, "type": 4, "under": 4, "variou": 4, "video": 0, "weight": 0, "when": 4, "whether": 4, "work": 0}, "titles": ["PyNeon documentation", "pyneon.NeonDataset", "PyNeon API", "pyneon.preprocess", "pyneon.NeonRecording", "PyNeon Tutorials"], "titleterms": {"api": 2, "data": 0, "document": 0, "format": 0, "instal": 0, "neondataset": 1, "neonrecord": 4, "preprocess": 3, "pyneon": [0, 1, 2, 3, 4, 5], "tutori": 5}}) \ No newline at end of file diff --git a/docs/_build/html/tutorials/index.html b/doc/tutorials/index.html similarity index 100% rename from docs/_build/html/tutorials/index.html rename to doc/tutorials/index.html diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 203822c..0000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree deleted file mode 100644 index 7b0e64c..0000000 Binary files a/docs/_build/doctrees/index.doctree and /dev/null differ diff --git a/docs/_build/doctrees/reference/dataset.doctree b/docs/_build/doctrees/reference/dataset.doctree deleted file mode 100644 index 8b8a507..0000000 Binary files a/docs/_build/doctrees/reference/dataset.doctree and /dev/null differ diff --git a/docs/_build/doctrees/reference/index.doctree b/docs/_build/doctrees/reference/index.doctree deleted file mode 100644 index 37c7aad..0000000 Binary files a/docs/_build/doctrees/reference/index.doctree and /dev/null differ diff --git a/docs/_build/doctrees/reference/preprocess.doctree b/docs/_build/doctrees/reference/preprocess.doctree deleted file mode 100644 index 803499c..0000000 Binary files a/docs/_build/doctrees/reference/preprocess.doctree and /dev/null differ diff --git a/docs/_build/doctrees/reference/recording.doctree b/docs/_build/doctrees/reference/recording.doctree deleted file mode 100644 index 4ad9910..0000000 Binary files a/docs/_build/doctrees/reference/recording.doctree and /dev/null differ diff --git a/docs/_build/doctrees/tutorials/index.doctree b/docs/_build/doctrees/tutorials/index.doctree deleted file mode 100644 index a2f453e..0000000 Binary files a/docs/_build/doctrees/tutorials/index.doctree and /dev/null differ diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js deleted file mode 100644 index 2c1cb8c..0000000 --- a/docs/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"alltitles": {"Data format": [[0, "data-format"]], "Installation": [[0, "installation"]], "PyNeon API": [[2, null]], "PyNeon Tutorials": [[5, null]], "PyNeon documentation": [[0, null]], "pyneon.NeonDataset": [[1, null]], "pyneon.NeonRecording": [[4, null]], "pyneon.preprocess": [[3, null]]}, "docnames": ["index", "reference/dataset", "reference/index", "reference/preprocess", "reference/recording", "tutorials/index"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "reference\\dataset.rst", "reference\\index.rst", "reference\\preprocess.rst", "reference\\recording.rst", "tutorials\\index.rst"], "indexentries": {"concat_channels() (pyneon.neonrecording method)": [[4, "pyneon.NeonRecording.concat_channels", false]], "eye_states (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.eye_states", false]], "gaze (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.gaze", false]], "imu (pyneon.neonrecording property)": [[4, "pyneon.NeonRecording.imu", false]], "module": [[0, "module-pyneon", false], [3, "module-pyneon.preprocess", false]], "neondataset (class in pyneon)": [[1, "pyneon.NeonDataset", false]], "neonrecording (class in pyneon)": [[4, "pyneon.NeonRecording", false]], "pyneon": [[0, "module-pyneon", false]], "pyneon.preprocess": [[3, "module-pyneon.preprocess", false]]}, "objects": {"": [[0, 0, 0, "-", "pyneon"]], "pyneon": [[1, 1, 1, "", "NeonDataset"], [4, 1, 1, "", "NeonRecording"], [3, 0, 0, "-", "preprocess"]], "pyneon.NeonRecording": [[4, 2, 1, "", "concat_channels"], [4, 3, 1, "", "eye_states"], [4, 3, 1, "", "gaze"], [4, 3, 1, "", "imu"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property"}, "terms": {"3d": 4, "3d_eye_st": 4, "It": 0, "The": 0, "These": 4, "To": 0, "access": 4, "aesthet": 0, "all": 4, "alreadi": 4, "ar": [0, 4], "associ": [], "attribut": 4, "bool": 4, "can": 4, "ch_name": 4, "channel": 4, "chu": 0, "class": [1, 2, 4], "clone": 0, "cloud": 0, "column": 4, "common": 4, "concat_channel": 4, "concaten": 4, "conda": 0, "could": 0, "data": 4, "datafram": 4, "dataset": [], "dataset_dir": 1, "default": 4, "detail": 4, "develop": 0, "downsampl": 4, "empir": 0, "export": 0, "ey": [0, 4], "eye_st": 4, "first": 4, "float": 4, "from": [0, 4], "function": 2, "futur": 0, "gabriel": 0, "gaze": 4, "hartel": 0, "holder": [], "i": [0, 2, 4], "imu": 4, "institut": 0, "interpol": 4, "jan": 0, "lab": 0, "lazili": 4, "librari": 0, "light": 0, "linear": 4, "list": 4, "load": 4, "max": 0, "mean": 4, "method": 4, "modal": [0, 4], "more": 4, "multi": 0, "multipl": [0, 1], "name": 4, "ncclabmpi": 0, "nearest": 4, "neon": 0, "neoneyest": 4, "neongaz": 4, "neonimu": 4, "non": [], "object": [1, 4], "one": 4, "onli": 4, "option": 4, "origin": 0, "other": 4, "paramet": 4, "path": [1, 4], "pd": 4, "pip": 0, "plan": 0, "planck": 0, "preprocess": 4, "project": 0, "properti": 4, "pupil": 0, "pyneon": [], "pypi": 0, "qian": 0, "record": [0, 1, 4], "recording_dir": 4, "referencc": 2, "releas": 0, "repositori": 0, "requir": 4, "resamp_float_kind": 4, "resamp_other_kind": 4, "resampl": 4, "return": 4, "run": 0, "same": 4, "see": 4, "signal": 4, "singl": [0, 4], "specif": 4, "state": 4, "str": [1, 4], "thi": [2, 4], "time": 4, "timeseri": 0, "timestamp": 4, "track": 0, "true": 4, "type": 4, "under": 4, "variou": 4, "weight": 0, "when": 4, "whether": 4, "work": 0}, "titles": ["PyNeon documentation", "pyneon.NeonDataset", "PyNeon API", "pyneon.preprocess", "pyneon.NeonRecording", "PyNeon Tutorials"], "titleterms": {"api": 2, "data": 0, "document": 0, "format": 0, "instal": 0, "neondataset": 1, "neonrecord": 4, "paramet": [], "preprocess": 3, "pyneon": [0, 1, 2, 3, 4, 5], "tutori": 5}}) \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 7274d5e..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -sphinx -pydata-sphinx-theme \ No newline at end of file diff --git a/docs/make.bat b/make.bat similarity index 94% rename from docs/make.bat rename to make.bat index 954237b..dc1312a 100644 --- a/docs/make.bat +++ b/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=. -set BUILDDIR=_build +set SOURCEDIR=source +set BUILDDIR=build %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( diff --git a/pyneon/recording.py b/pyneon/recording.py index b3e33b0..23246f1 100644 --- a/pyneon/recording.py +++ b/pyneon/recording.py @@ -164,5 +164,10 @@ def concat_channels( Resampling method for columns of float type, by default "linear". resamp_other_kind : str, optional Resampling method for columns of other types, by default "nearest". + + Returns + ------- + concat_data : pd.DataFrame + Concatenated data. """ return concat_channels(self, ch_names, resamp_float_kind, resamp_other_kind) diff --git a/docs/conf.py b/source/conf.py similarity index 100% rename from docs/conf.py rename to source/conf.py diff --git a/docs/index.rst b/source/index.rst similarity index 71% rename from docs/index.rst rename to source/index.rst index 11cfb0c..cc49de9 100644 --- a/docs/index.rst +++ b/source/index.rst @@ -13,7 +13,7 @@ Installation ============ To install PyNeon, clone the PyNeon repository from -https://github.com/NCCLabMPI/pyneon and run: +https://github.com/NCCLabMPI/PyNeon and run: .. code-block:: bash @@ -24,7 +24,9 @@ PyPI and conda releases are planned for the future. Data format =========== -PyNeon works with the "Timeseries" data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings. +PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" formats +as exported from Pupil Clouds. The data could be from a single recording or from a +project with multiple recordings. .. toctree:: :maxdepth: 1 diff --git a/docs/reference/dataset.rst b/source/reference/dataset.rst similarity index 100% rename from docs/reference/dataset.rst rename to source/reference/dataset.rst diff --git a/docs/reference/index.rst b/source/reference/index.rst similarity index 100% rename from docs/reference/index.rst rename to source/reference/index.rst diff --git a/docs/reference/preprocess.rst b/source/reference/preprocess.rst similarity index 100% rename from docs/reference/preprocess.rst rename to source/reference/preprocess.rst diff --git a/docs/reference/recording.rst b/source/reference/recording.rst similarity index 100% rename from docs/reference/recording.rst rename to source/reference/recording.rst diff --git a/docs/tutorials/index.rst b/source/tutorials/index.rst similarity index 100% rename from docs/tutorials/index.rst rename to source/tutorials/index.rst