Skip to content

docs(server): describe processing jobs backend contract #923

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.

Sign up for GitHub

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

Merged
PaulHax merged 1 commit into from
Aug 17, 2026
Merged

docs(server): describe processing jobs backend contract #923

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions docs/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ The VolView server extends the VolView viewer with remote processing
capabilities. It integrates with your Python-based code and exposes that
functionality directly into the viewer.

## Processing Jobs

The server described here exposes Python functions as RPCs the viewer calls
directly. For longer-running work, VolView also ships a Jobs panel that talks to
a processing backend over the neutral API defined in the `backend-contract`
package: the backend advertises its tasks, VolView builds the submission form
from each task specification, and completed outputs load back into the scene as
images, layers, or segment groups. Any service that implements the contract
works, since VolView knows only the shared vocabulary and never a backend's
native task format.

[girder_volview](https://github.com/DigitalSlideArchive/girder_volview) is a
working implementation that runs tasks as
[Slicer CLI Web](https://github.com/girder/slicer_cli_web) images. See its
[job processing design](https://github.com/DigitalSlideArchive/girder_volview/blob/main/docs/job-processing.md)
for the execution flow, and the schemas in `backend-contract/` for the API
itself.

## Quick Start

There are two parts to getting started with this VolView server example: the
Expand Down
Loading