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

updated documentation front page #3917

Merged
merged 4 commits into from
Mar 20, 2019
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
19 changes: 8 additions & 11 deletions docs/hello.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The web-based tool is powered by a specialized data-delivery backend that stores
webKnossos has a GPU-accelerated viewer that includes tools for creating and sharing annotations (skeletons and volumes).
Powerful [user](./users.md) and [task](./tasks.md) management features automatically distribute tasks to human annotators.
There are a lot of productivity improvements to make the human part as efficient as possible.
webKnossos is also a platform for [showcasing datasets](https://demo.webknossos.org) alongside a paper publication.
webKnossos is also a platform for [showcasing datasets](https://webknossos.org) alongside a paper publication.

> Boergens, Berning, Bocklisch, Bräunlein, Drawitsch, Frohnhofen, Herold, Otto, Rzepka, Werkmeister, Werner, Wiese, Wissler and Helmstaedter
webKnossos: efficient online 3D data annotation for connectomics.
Expand All @@ -14,24 +14,21 @@ webKnossos: efficient online 3D data annotation for connectomics.
![webKnossos logo](https://webknossos.org/images/oxalis.svg)

## Demo
Dataset gallery: [https://demo.webknossos.org/](https://demo.webknossos.org/)
Try webKnossos yourself: [https://try.webknossos.org/](https://try.webknossos.org/)
Try webKnossos yourself on a large selection of publish community datasets: [https://webknossos.org/](https://webknossos.org/)

## Features
* Exploration of large 3D image datasets
* Fully browser-based user experience with efficient data streaming
* Creation/editing of [skeleton and volume annotations](./tracing_ui.md)
* Creation/editing of skeleton and volume annotations
* [Innovative flight mode for fast skeleton tracing](https://www.nature.com/articles/nmeth.4331)
* Optimized performance for large datasets and annotations
* [User](./users.md) and [task](./tasks.md) management for high-throughput crowdsourcing
* [Sharing and collaboration](./sharing.md) features
* Efficient [keyboard shortcuts](./keyboard_shortcuts.md)
* Undo/Redo functionality
* Optimized performance for large tracings
* User and task management for high-throughput crowdsourcing
* Sharing and collaboration features
* [Standalone datastore component](https://github.com/scalableminds/webknossos/tree/master/webknossos-datastore) for flexible deployments
* [Supported dataset formats](./datasets.md): WKW (Optimized), KNOSSOS cubes
* [Supported dataset formats: WKW (Optimized), KNOSSOS cubes](https://github.com/scalableminds/webknossos/wiki/Datasets), [Neuroglancer Precomputed, and BossDB](https://github.com/scalableminds/webknossos-connect)
* [Supported image formats](./data_formats.md): Grayscale, Segmentation Maps, RGB, Multi-Channel
* [Mesh Visualization](./mesh_visualization.md)
* [Documented frontend API for user scripts](https://demo.webknossos.org/assets/docs/frontend-api/index.html), REST API for backend access
* [Documented frontend API for user scripts](https://webknossos.org/assets/docs/frontend-api/index.html), REST API for backend access
* Open-source development with [automated test suite](https://circleci.com/gh/scalableminds/webknossos)
* [Docker-based deployment](https://hub.docker.com/r/scalableminds/webknossos/) for production and development

Expand Down
2 changes: 1 addition & 1 deletion docs/sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To manage access rights to certain datasets for webKnossos users check out [the

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](mailto:[email protected]) to feature your dataset on https://demo.webknossos.org.
[Please contact us](mailto:[email protected]) to feature your dataset on https://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](mailto:[email protected])).
Expand Down
2 changes: 1 addition & 1 deletion docs/tracing_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The most common buttons are:
- `Archive`: Only available for Explorative Annotations. Closes the annotation and archives it, removing it from a user's dashboard. Archived annotations can be found on a user's dashboard under "Explorative Annotations" and by clicking on "Show Archived Annotations". Use this to declutter your dashboard.
- `Download`: Starts the download of the current annotation. Skeleton annotations are downloaded as [NML](./data_formats.md#nml) files. Volume annotation downloads contain the raw segmentation data as [WKW](./data_formats.md#wkw) files.
- `Share`: Create a shareable link to your dataset containing the current position, rotation, zoom level etc. Use this to collaboratively work with colleagues. Read more about this feature in the [Sharing guide](./sharing.md).
- `Add Script`: Using the [webKnossos frontend API](https://demo.webknossos.org/assets/docs/frontend-api/index.html) users can interact with webKnossos programmatically. User scripts can be executed from here. Admins can add often used scripts to webKnossos to make them available to all users for easy access.
- `Add Script`: Using the [webKnossos frontend API](https://webknossos.org/assets/docs/frontend-api/index.html) users can interact with webKnossos programmatically. User scripts can be executed from here. Admins can add often used scripts to webKnossos to make them available to all users for easy access.
- `Restore Older Version`: Opens a view that shows all previous versions of a tracing. From this view, any older version can be selected, previewed, and restored.

A user can directly jump to positions within their datasets by entering them in the position input field.
Expand Down