From d2faa887811e4541dd7b14550a43b3d06f98d48c Mon Sep 17 00:00:00 2001 From: Filip Leonarski Date: Tue, 3 Nov 2026 11:51:15 +0100 Subject: [PATCH] Regenerate the Python client docs, frontend client and Redoc after the stills-live merge (update_version.sh) Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01UqXYdJKPUFLoeAchjzv3x4 --- broker/redoc-static.html | 6 +-- docs/python_client/README.md | 1 + docs/python_client/docs/RugnuxLiveStatus.md | 1 + docs/python_client/docs/RugnuxLiveStills.md | 44 +++++++++++++++++++++ docs/python_client/docs/RugnuxSettings.md | 4 +- frontend/src/client/index.ts | 2 +- 6 files changed, 52 insertions(+), 6 deletions(-) create mode 100644 docs/python_client/docs/RugnuxLiveStills.md diff --git a/broker/redoc-static.html b/broker/redoc-static.html index 6965f23ed..30d4eea27 100644 --- a/broker/redoc-static.html +++ b/broker/redoc-static.html @@ -844,7 +844,7 @@ Changing detector will set detector to Inactive state and will requ

Responses

Response samples

Content type
application/json
{
  • "detectors": [
    ],
  • "current_id": 0
}

Change rugnux live mode settings

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
enable
boolean
Default: false

Process DECTRIS rotation collections with rugnux live

+
Request Body schema: application/json
enable
boolean
Default: false

Process DECTRIS rotation collections with rugnux live, and FPGA serial collections on the GPU after a pre-pass

reserved_cpus
integer <int64> >= 0
Default: 4

CPU threads left to the receiver and the image pusher while rugnux runs

deadline_s
number <double> >= 0
Default: 60

Fixed cutoff: this long after the last image the analysis is cut, and the collection ends with what it has established (as POST /cancel after the last image does). 0 means no cutoff.

@@ -872,7 +872,7 @@ and validation of every following rugnux live collection, until it is removed wi
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "state": "Idle",
  • "placed_model": true,
  • "refined_model": true,
  • "anomalous_map": true,
  • "anomalous_signal": true,
  • "model": {
    },
  • "space_group": "string",
  • "d_min": 0.1,
  • "isa": 0.1,
  • "probe": "string",
  • "probe_s": 0.1,
  • "start_to_first_image_s": 0.1,
  • "message": "string",
  • "images_expected": 0,
  • "expected_collection_s": 0.1,
  • "images_received": 0,
  • "elapsed_s": 0.1,
  • "step_progress": 1,
  • "steps": [
    ],
  • "last_image_s": 0.1,
  • "cut": "string",
  • "cut_s": 0.1,
  • "last_image_to_written_s": 0.1,
  • "verdict": "string",
  • "verdict_text": "string",
  • "summary": [
    ],
  • "warnings": [
    ]
}

Get the model as placed by the last rugnux live run

The model placed against the data by molecular replacement or validation, as mmCIF - the same text as the +

http://localhost:5232/rugnux/status

Response samples

Content type
application/json
{
  • "state": "Idle",
  • "placed_model": true,
  • "refined_model": true,
  • "anomalous_map": true,
  • "anomalous_signal": true,
  • "model": {
    },
  • "stills": {
    },
  • "space_group": "string",
  • "d_min": 0.1,
  • "isa": 0.1,
  • "probe": "string",
  • "probe_s": 0.1,
  • "start_to_first_image_s": 0.1,
  • "message": "string",
  • "images_expected": 0,
  • "expected_collection_s": 0.1,
  • "images_received": 0,
  • "elapsed_s": 0.1,
  • "step_progress": 1,
  • "steps": [
    ],
  • "last_image_s": 0.1,
  • "cut": "string",
  • "cut_s": 0.1,
  • "last_image_to_written_s": 0.1,
  • "verdict": "string",
  • "verdict_text": "string",
  • "summary": [
    ],
  • "warnings": [
    ]
}

Get the model as placed by the last rugnux live run

The model placed against the data by molecular replacement or validation, as mmCIF - the same text as the _model.cif file written beside the data: the data's cell and space group, with the input model's own metadata (entities, sequences, references, authors, software) kept. Kept as long as /rugnux/status. Where the run refined the model, the refined model unless asked for stage=placed.

@@ -1131,7 +1131,7 @@ then image might be replaced in the buffer between calling /images and /image.cb