Skip to content

Commit fa5d4fd

Browse files
committed
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.
1 parent 38d39f9 commit fa5d4fd

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

‎docs/server.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@ The VolView server extends the VolView viewer with remote processing
44
capabilities. It integrates with your Python-based code and exposes that
55
functionality directly into the viewer.
66

7+
## Processing Jobs
8+
9+
The server described here exposes Python functions as RPCs the viewer calls
10+
directly. For longer-running work, VolView also ships a Jobs panel that talks to
11+
a processing backend over the neutral API defined in the `backend-contract`
12+
package: the backend advertises its tasks, VolView builds the submission form
13+
from each task specification, and completed outputs load back into the scene as
14+
images, layers, or segment groups. Any service that implements the contract
15+
works, since VolView knows only the shared vocabulary and never a backend's
16+
native task format.
17+
18+
[girder_volview](https://github.com/DigitalSlideArchive/girder_volview) is a
19+
working implementation that runs tasks as
20+
[Slicer CLI Web](https://github.com/girder/slicer_cli_web) images. See its
21+
[job processing design](https://github.com/DigitalSlideArchive/girder_volview/blob/main/docs/job-processing.md)
22+
for the execution flow, and the schemas in `backend-contract/` for the API
23+
itself.
24+
725
## Quick Start
826

927
There are two parts to getting started with this VolView server example: the

0 commit comments

Comments
 (0)