Merge pull request #9 from biomarkersParkinson/add-example

Adds ipynb example
biomarkersParkinson · Apr 26, 2023 · dfa1607 · dfa1607
2 parents b785d3c + c17e9ce
commit dfa1607
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 25 deletions.
diff --git a/examples/processing_example.ipynb → docs/processing_example.ipynb b/examples/processing_example.ipynb → docs/processing_example.ipynb
@@ -1,21 +1,22 @@
 {
  "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Examples\n",
+    "\n",
+    "These are some examples on how to read and write TSDF data into and from a numpy array."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 318,
+   "execution_count": 1,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The autoreload extension is already loaded. To reload it, use:\n",
-      "  %reload_ext autoreload\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
-    "# Reload modules automatically on changes\n",
+    "# Reload modules automatically on changes; useful for developing\n",
     "%load_ext autoreload\n",
     "%autoreload 2"
    ]
@@ -30,7 +31,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 319,
+   "execution_count": 2,
    "metadata": {
     "tags": []
    },
@@ -55,7 +56,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 320,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -89,7 +90,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 321,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -120,7 +121,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 322,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -148,7 +149,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 323,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -173,7 +174,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 324,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -191,7 +192,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 325,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -227,7 +228,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 326,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -268,7 +269,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 327,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -278,7 +279,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 328,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -289,7 +290,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "tsdf-jvrgVaBR-py3.9",
+   "display_name": "tsdf-zVA6tG---py3.9",
    "language": "python",
    "name": "python3"
   },
@@ -303,12 +304,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.12"
+   "version": "3.9.13"
   },
   "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
-    "hash": "0d75824af0ee1a2e7ac98055f9a1e179243bcaf829c515bd362f48ceaa63be97"
+    "hash": "d1e978847a77d4ff49203fd09f0f7925f58560bf1007438482d75cb657018d9b"
    }
   }
  },

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,5 +12,6 @@ theme: readthedocs
 nav:
   - Introduction: index.md
   - Installation: installation.md
+  - Example: processing_example.ipynb
   - Usage: usage.ipynb
   - Contact: contact.md