Sharing

Last updated 3 months ago

webKnossos is built for working collaboratively and sharing your work with the community. webKnossos can share both skeleton annotations of large structures as well as raw datasets and segmentations for showcasing the data. The sharing features discussed here refer to sharing scenarios with colleagues, reviewers, and publishers outside of your webKnossos organization or your lab.

To manage access rights to certain datasets for webKnossos users check out the Datasets guide.

Dataset Sharing

Dataset sharing allows outside users to view your datasets and segmentation layers within webKnossos. Shared resources can be accessed through a direct URL or can be featured on a spotlight gallery for showcasing your work. Please contact us to feature your dataset on https://demo.webknossos.org.

Sharing a dataset is useful for multiple scenarios:

  • You recorded a novel microscopy dataset and want to include links to it in your paper or for reviewers. Use wklink.org to shorten these URLs, e.g. https://wklink.org/5386 (contact us).

  • You created an interesting, highly-accurate segmentation layer for an existing dataset and want to share it for your publication.

  • You have worked and published several datasets over the years and want to have a single gallery for all your public datasets.

webKnossos shares datasets publicly (everyone can view them without any login) or privately (a login or special URLs are required to view the link).

Private Sharing for Review

A privately shared dataset can only be accessed from outside users your using the correct URL. A unique authentification token is part of the URL so anyone with this URL has access rights for viewing the dataset. The dataset is NOT featured publicly anywhere else on your webKnossos instance.

Private sharing is useful for giving outside users (reviewers, editors, journalists etc.) an opportunity to look at your data without having to publish it publicly.

To share a dataset privately, follow these steps:

  1. Navigate to your user dashboard and Datasets.

  2. Select the dataset that you want to share and click on Edit.

  3. Under the General tab, scroll down to the Sharing Link and copy it.

That's all you need to do.

Configure the Dataset Sharing

To revoke a sharing link in the future, click the Revoke button to the right-hand side of the link.

Do not enable the Make dataset publicly accessible checkbox or otherwise, your dataset will be featured on the front page of your webKnossos instance. Public access rights are not required for private sharing.

Public Sharing

Public sharing provides access to your dataset to the general public. Anyone can access the shared dataset and view it on your webKnossos instance without the need for an account. Further, publicly shared datasets are featured in a dataset gallery on your webKnossos start page for logged-out users. Alternatively, navigate to https://<webKnossos-url>/spotlight.

The Dataset Gallery view provides a public showcase of all your published datasets. No wK account is required to view these.

Public datasets provide an easy and convenient way of sharing your data with outside users after you have successfully published them. Outside users can navigate through your data from the comfort of their own browser.

To share a dataset publicly, follow these steps:

  1. Navigate to your user dashboard and Datasets.

  2. Select the dataset that you want to share and click on Edit.

  3. Under the General tab, scroll down to the checkbox Make dataset publicly accessible and enable it.

  4. On the same screen, you can add/edit a dataset's description and give it more appropriate tile (Display name).

  5. On the same screen, copy the sharing link.

That's all you need to do.

We recommend giving your datasets a meaningful display name and description. Both are featured next to a preview of the dataset in the gallery of promoted public datasets.

Annotation Sharing

Besides sharing just the data layers for viewing, webKnossos can also share complete annotation, e.g. a large skeleton reconstruction. Annotation sharing works for both skeletons and volume tracings.

Annotations can be shared publicly and privately. Public tracings do not require any user authentication and are a great option for sharing a link to your annotation from social media or your website. Unlike with datasets, publicly shared annotations are not featured in a gallery.

Private sharing requires the recipient of a link to log in with his webKnossos accounts. This is primarily used for sharing annotations with your co-workers, e.g. for highlighting interesting positions in your work. Since your position, rotation, zoom etc. is encoded in the URL, it is a great way for working collaboratively. Just send an URL to your co-workers in an email or blog post and they may jump right into the annotation at your location.

Since every annotation is tied to an individual webKnossos user, co-workers cannot modify your annotation if you share it with them. Instead, the shared annotation will be read-only. If your co-workers want to make modifications to the annotation, they can click the Copy to my Account button in the toolbar. This will make a copy of the annotation, link it to the co-workers' accounts and enable modifications again. Think of this feature like GitHub forks. Changes made to the copy are not automatically synced with the original.

To share an annotation, follow these steps:

  1. Open your annotation in the regular tracing view.

  2. From the toolbar select Share from the overflow menu next to the Save button.

  3. Copy the sharing URL for private access.

  4. Enable public sharing with the checkbox, if required.

Configure the Annotation Sharing

For public annotations to work properly, the underlying dataset must also be shared publicly or privately (via token URL). Otherwise, the annotation and data cannot be loaded by webKnossos and an error will occur. Learn how to share datasets publicly above.‚Äč

Next to the integrated Annotation Sharing features, you can also download NML files and send them via email to collaborators.