From 90d0d3c3f90c17c08d34954e98f356baad59e80f Mon Sep 17 00:00:00 2001 From: Filip Leonarski Date: Wed, 2 Sep 2026 10:35:12 +0200 Subject: [PATCH] docs: the python client reference, for the two schemas that gained fields 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) --- docs/python_client/docs/DatasetSettings.md | 2 ++ docs/python_client/docs/PowderCalibrationQuality.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/python_client/docs/DatasetSettings.md b/docs/python_client/docs/DatasetSettings.md index e01f62941..03b2dba41 100644 --- a/docs/python_client/docs/DatasetSettings.md +++ b/docs/python_client/docs/DatasetSettings.md @@ -19,6 +19,8 @@ Name | Type | Description | Notes **compression** | **str** | Compression type for the images transferred over ZeroMQ and saved to HDF5 file. | [optional] [default to 'bslz4'] **total_flux** | **float** | /entry/beam/total_flux in NXmx Flux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s] | [optional] **transmission** | **float** | /entry/instrument/attenuator/attenuator_transmission Transmission of attenuator (filter) [no units] | [optional] +**beam_size_x_um** | **float** | First element of /entry/instrument/beam/incident_beam_size in NXmx Horizontal size of the X-ray beam where it meets the sample - the FWHM of a focused beam, the full width of a slit-defined one. [um] | [optional] +**beam_size_y_um** | **float** | Second element of /entry/instrument/beam/incident_beam_size in NXmx Vertical size of the X-ray beam where it meets the sample. [um] | [optional] **goniometer** | [**RotationAxis**](RotationAxis.md) | | [optional] **grid_scan** | [**GridScan**](GridScan.md) | | [optional] **header_appendix** | **object** | Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON) In general, it is not saved in HDF5 file. However, if values are placed in \"hdf5\" object, `jfjoch_writer` will write them in /entry/user of the HDF5 file. This applies solely to string and number (double floating-point). No arrays/sub-objects is allowed. For example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2. | [optional] diff --git a/docs/python_client/docs/PowderCalibrationQuality.md b/docs/python_client/docs/PowderCalibrationQuality.md index 184ad8bac..e8f475f21 100644 --- a/docs/python_client/docs/PowderCalibrationQuality.md +++ b/docs/python_client/docs/PowderCalibrationQuality.md @@ -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]