Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
magland committed Mar 3, 2024
2 parents 664f68d + 8753fa6 commit 3803c9b
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions doc/neurosift_annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,22 @@ easily with others. Possible names could be "annotations",
"neurosift-annotations", or "dandi-annotations". The same repo can be used to
hold annotations for multiple NWB files in multiple DANDIsets.

**Step 2: Install the neurosift-annotations GitHub app on your repository** (this is a one-time step)
**Step 2: Install the neurosift-annotations GitHub app for your GitHub account** (this is a one-time step)

Go to the [neurosift-annotations GitHub app](https://github.com/apps/neurosift-annotations) and click "Install".
Following the principle of least privilege, you should give access only to the repository where you want to store your annotations.

**Step 3: Authenticate with GitHub in Neurosift to give it access to your installed app**

In Neurosift, click on the key icon in the top right corner and click to log in
In [Neurosift](https://flatironinstitute.github.io/neurosift), click on the key icon in the top right corner and click to log in
to neurosift-annotations. This will allow Neurosift to access your GitHub
repository to store your annotations.

## Usage

Navigate to a DANDI NWB file in Neurosift. You will see a new "Annotations" tab.
Click on this tab to get more information about viewing and managing the
annotations for this file. Once you have set up neurosift-annotations and logged
in, you will be able to attach a top-level text note to the file or to any
annotations for this file. You will specify your repo there. Once you have set this up, you will be able to attach a top-level text note to the file or to any
neurodata object in the file.

## How annotations are stored in the repository
Expand Down Expand Up @@ -66,4 +65,4 @@ except this would of course be formatted as a single line in the file.

For now the only type of annotation is a "note", which is a piece of text that
can be attached to any neurodata object in the NWB file. In the future we plan
to support other types of annotations such as unit curations, etc.
to support other types of annotations such as unit curations, etc.

0 comments on commit 3803c9b

Please sign in to comment.