From 79ec439eb21e09219127b71f6f7278ad98bd5296 Mon Sep 17 00:00:00 2001 From: Paul Elliott Date: Thu, 6 Aug 2026 15:51:17 -0400 Subject: [PATCH] docs(server): describe processing jobs backend contract Distinguish the RPC server from the Jobs panel and point at girder_volview as a working backend implementation. --- docs/server.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/server.md b/docs/server.md index 55dd726d0..297ac4d97 100644 --- a/docs/server.md +++ b/docs/server.md @@ -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