Skip to content

Commit

Permalink
Add documentation of GIN URLs for public and private repos
Browse files Browse the repository at this point in the history
  • Loading branch information
jpgill86 committed Aug 10, 2019
1 parent 2e65c76 commit 52d379b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
19 changes: 19 additions & 0 deletions docs/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,25 @@ to the metadata file. In the example above, if the metadata file is located in
user name and password. This makes it easy to share the **neurotic**
experience with your colleagues! 🤪

.. _gin-urls:

URLs to Use with GIN
....................

If you have data stored in a **public** repository on GIN_, you can access it
from a URL of this form::

https://gin.g-node.org/<username>/<reponame>/raw/master/<path>

For **private** repositories, you must use a different URL that takes advantage
of the WebDAV protocol::

https://gin.g-node.org/<username>/<reponame>/_dav/<path>

The second form works with public repos too, but GIN login credentials are
still required. Consequently, the first form is more convenient for public
repos.

.. _congig-metadata-globals:

Global Configuration Settings
Expand Down
2 changes: 1 addition & 1 deletion neurotic/example/metadata.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ example dataset:

# these data are a subset of Jeffrey Gill's dataset 2018-06-21_IN-VIVO_JG-08 002
data_dir: example-data
remote_data_dir: https://web.gin.g-node.org/jpgill86/neurotic-data/raw/master/examples/example-data
remote_data_dir: https://gin.g-node.org/jpgill86/neurotic-data/raw/master/examples/example-data
data_file: data.axgx
video_file: video.mp4
annotations_file: annotations.csv
Expand Down
2 changes: 1 addition & 1 deletion neurotic/tests/metadata-for-tests.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
neurotic_config:
remote_data_root: https://web.gin.g-node.org/jpgill86/neurotic-data/raw/master/tests
remote_data_root: https://gin.g-node.org/jpgill86/neurotic-data/raw/master/tests

video-jumps-unset:
data_dir: events-and-epochs
Expand Down

0 comments on commit 52d379b

Please sign in to comment.