Skip to content

Tutorials

Tutorials are task-based walkthroughs. Each one starts from a working installation or a reachable server, states what you need, and ends with a result you can check.

Set up DSA first

If you do not have an instance yet, start with an installation walkthrough:

To look around without installing anything, use Try the demo.

Everyday tasks

These tutorials cover the actions people need first.

  • Connect to a DSA server — sign in through the browser, find your workspace, and optionally connect from a script with an API key.
  • Create a collection — start a shared data tree and set who can see it.
  • Create a folder — add a folder in your personal space, a collection, or another folder.
  • Upload or import images — choose between drag and drop, girder-client, the REST API, and importing files that are already on a bind-mounted data store.
  • Share a collection or folder — grant a user or group the right role, make a folder public, and handle annotation access.
  • Copy an item — duplicate a slide and its metadata into another folder.
  • Edit metadata — add, change, and delete key/value metadata on items, folders, and collections.

Viewer and annotation

When something goes wrong

  • Troubleshooting and FAQ — symptom-first fixes for installation, sign-in, viewing, upload, permissions, annotations, and analysis jobs.

Planned tutorials

These will be written once they can be run against a current release and a dedicated test instance.

  • Set up a multi-user annotation review with a shared style-group palette.
  • Convert annotations to masks and back with HistomicsTK.
  • Back up and restore the Girder database and assetstore.

Existing examples

The upstream site's Documentation & Examples URL is now a redirect to the upstream MkDocs documentation. Its one linked demo is already covered by Try the demo. There is no separate tutorial list there to copy.

Source and version

Connect, create a folder, copy an item, and edit metadata were click-tested with a signed-in account on https://pub-data.bdsa.io/ on 2026-11-01, and the screenshots come from that run. Create a collection is source-verified only: that instance restricts self-service collection creation to administrators.

Annotate a slide and Run an analysis are source-verified against HistomicsUI at commit 75a9be6, not click-tested on a writable slide. Their pages state the limits.