Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for creating a Webknossos dataset #23

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/img/webknossos_add_dataset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/webknossos_asset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/webknossos_dataset_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/webknossos_name_field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/webknossos_remote_dataset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/webknossos_uri.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions docs/webknossos-add-dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Add Webknossos Dataset

The following steps provide instructions for adding assets from the LINC Data Platform to LINC Webknossos. This process has not been automated as it is often the case that multiple assets are added as layers to a single Webknossos dataset, and a pattern for adding these layers has not yet been established.

1. Navigate to an asset on the [LINC Data Platform](https://lincbrain.org/), and find the “Copy” button:

![](img/webknossos_asset.png)

2. Select the AWS S3 URI “Copy” button:

![](img/webknossos_uri.png)

3. The AWS S3 URI is now copied to your clipboard.

4. Proceed to [LINC Webknossos](https://webknossos.lincbrain.org).

5. Under the “Datasets” tab, select “+ Add Dataset”:

![](img/webknossos_add_dataset.png)

6. Navigate to the “Add Remote Dataset” tab:

![](img/webknossos_remote_dataset.png)

7. Paste the AWS S3 URI in the “Dataset URL” field and select “Add Layer”.

8. Add the dataset name that follows the convention below:

![](img/webknossos_name_field.png)

- For a Webknossos dataset with a single layer, the name should match the file naming convention on the LINC Data Platform. And include the folder tree in the filename, whereby each subdirectory is separated by an underscore. For example, the last Zarr asset in the figure below would be named as follows: `000003_rawdata_sub-MN115_micr_sub-MN115_sample-slice0000slice0025_stain-LY_DF.ome.zarr`

![](img/webknossos_dataset_name.png)

- For a Webknossos dataset with multiple layers, the naming scheme is currently under discussion here: https://github.com/lincbrain/webknossos/issues/19.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- Welcome: "index.md"
- Upload data: "upload.md"
- Webknossos:
- Add Webknossos dataset: "webknossos-add-dataset.md"
- Deployment: https://github.com/lincbrain/webknossos/blob/ak-dev/LINC_DEPLOYMENT.md
- Development: https://github.com/lincbrain/webknossos/blob/ak-dev/LINC_DEVELOPMENT.md
- DANDI Docs: https://www.dandiarchive.org/handbook
Expand Down
Loading