mx/Jungfraujoch
2
1
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 73 Wiki Activity

docs: the python client reference, for the two schemas that gained fields

Browse Source 
docs/python_client/docs is generated from the API spec and copied in by
update_version.sh, so it goes stale between releases. The calibration
convergence gate and the beam size both added properties without it; this is
the same generator run those commits should have carried.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
leonarski_f
2026-09-02 10:35:12 +02:00
co-authored by Claude Opus 5
parent aa6073d41f
commit 90d0d3c3f9
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_client/docs/PowderCalibrationQuality.md
+2
View File
@@ -6,6 +6,8 @@ What a powder calibration knows about the geometry it produced. A calibration th
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**converged** | **bool** | Whether the geometry beside this is a measurement of the data at all. False means at least one of its parameters was carried over from the input file rather than fitted - which looks exactly like a good fit in every other field here - and see not_converged_reason for which. rugnux --mode calibration writes no .poni file in that case, a PONI file having no field in which to say it, and exits non-zero. | [optional]
**not_converged_reason** | **str** | What made converged false, in words. Absent when the calibration converged. | [optional]
**calibrant** | **str** | The powder standard the rings were fitted to, or the unit cell given in its place | [optional]
**method** | **str** | How the rings were measured. rings fits the arcs of the run-summed (q x azimuth) azimuthal profile; spots fits the pooled per-image spot lists. | [optional]
**ring_points** | **int** | Ring measurements the fit used | [optional]