Merge pull request #250 from jpgill86/new-examples

Add human balance beam and drone optical flow example datasets
jpgill86 · Mar 12, 2020 · 5eefb85 · 5eefb85
2 parents 8a64dea + d2fe009
commit 5eefb85
Show file tree

Hide file tree

Showing 10 changed files with 369 additions and 96 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,9 @@
 # Specific to this project
 /neurotic/version.py
-/neurotic/example/example-data/
 /neurotic/example/demo.yml
+/neurotic/example/drone-optical-flow/
+/neurotic/example/example-data/
+/neurotic/example/human-balance-beam/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,19 @@
+.. _metadata-examples:
+
+Metadata Examples
+=================
+
+Below, the contents of a fully functioning example metadata file are shown,
+which contains metadata for several example datasets. This file is included
+with each installation of **neurotic** and is loaded automatically when
+**neurotic** first starts.
+
+With this metadata file loaded in **neurotic**, you may use the "Download data"
+feature to fetch the data files and run the examples, and you may try the "Edit
+metadata" feature to test modifications (remember to "Reload metadata" after
+saving changes).
+
+:download:`Direct link <../neurotic/example/metadata.yml>`
+
+.. literalinclude:: ../neurotic/example/metadata.yml
+   :language: yaml
diff --git a/docs/index.rst b/docs/index.rst
@@ -26,6 +26,7 @@ at the same datasets!
    update
    gettingstarted
    metadata
+   examples
    api
    releasenotes
 

diff --git a/docs/metadata.rst b/docs/metadata.rst
@@ -716,18 +716,6 @@ is and is set by ``rauc_bin_duration``, given in seconds. If
 ``rauc_bin_duration`` is not specified (default ``None``), RAUC time series
 will not be calculated.
 
-.. _config-metadata-example:
-
-A Complete Example
-------------------
-
-These are the contents of the example metadata file that ships with
-**neurotic**, which can be loaded by running ``neurotic`` from the command line
-without arguments:
-
-.. literalinclude:: ../neurotic/example/metadata.yml
-   :language: yaml
-
 
 .. _elephant:               https://elephant.readthedocs.io/en/latest
 .. _GIN:                    https://gin.g-node.org

diff --git a/neurotic/example/example-notebook.ipynb b/neurotic/example/example-notebook.ipynb
@@ -305,7 +305,7 @@
    "outputs": [],
    "source": [
     "metadata = neurotic.MetadataSelector(file='./metadata.yml')\n",
-    "metadata.select('example dataset')\n",
+    "metadata.select('Aplysia feeding')\n",
     "metadata.download_all_data_files(overwrite_existing=False)"
    ]
   },