Files
Jungfraujoch/docs/python_client/docs/JfjochSettings.md
Filip Leonarski 64002f1e29
Some checks failed
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 11m14s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m43s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 11m35s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 9m20s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m23s
Build Packages / Generate python client (push) Successful in 39s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 11m24s
Build Packages / Create release (push) Has been skipped
Build Packages / Build documentation (push) Successful in 1m0s
Build Packages / build:rpm (rocky8) (push) Successful in 10m35s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 10m35s
Build Packages / build:rpm (rocky9) (push) Successful in 11m17s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 9m9s
Build Packages / Unit tests (push) Failing after 1h18m57s
v1.0.0-rc.129 (#36)
This is an UNSTABLE release. The release has significant modifications and bug fixes, if things go wrong, it is better to revert to 1.0.0-rc.124.

* jfjoch_broker: Significant improvements in TCP image socket, as a viable alternative for ZeroMQ sockets (only a single port on broker side, dynamically change number of writers, acknowledgments for written files)
* jfjoch_broker: Delta phi is calculated also for still data in Bragg prediction
* jfjoch_broker: Image pusher statistics are accessible via the REST interface
* jfjoch_writer: Supports TCP image socket and for these auto-forking option

Reviewed-on: #36
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-03-05 22:13:12 +01:00

2.7 KiB

JfjochSettings

Default settings for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.

Properties

Name Type Description Notes
pcie List[PcieDevicesInner] [optional]
zeromq ZeromqSettings [optional]
tcp TcpSettings [optional]
instrument InstrumentMetadata [optional]
file_writer FileWriterSettings [optional]
detector List[Detector]
indexing IndexingSettings [optional]
detector_settings DetectorSettings [optional]
azim_int AzimIntSettings [optional]
image_format ImageFormatSettings [optional]
image_buffer_mi_b int Size of internal buffer in MiB for images before they are sent to a stream [optional] [default to 2048]
verbose bool Print extra debug information [optional] [default to False]
receiver_threads int Number of threads used by the receiver [optional] [default to 64]
numa_policy str NUMA policy to bind CPUs [optional]
frontend_directory str Location of built JavaScript web frontend
ssl JfjochSettingsSsl [optional]
spot_finding SpotFindingSettings [optional]
image_pusher ImagePusherType [default to ImagePusherType.NONE]
zeromq_preview ZeromqPreviewSettings [optional]
zeromq_metadata ZeromqMetadataSettings [optional]
dark_mask DarkMaskSettings [optional]

Example

from jfjoch_client.models.jfjoch_settings import JfjochSettings

# TODO update the JSON string below
json = "{}"
# create an instance of JfjochSettings from a JSON string
jfjoch_settings_instance = JfjochSettings.from_json(json)
# print the JSON string representation of the object
print(JfjochSettings.to_json())

# convert the object into a dict
jfjoch_settings_dict = jfjoch_settings_instance.to_dict()
# create an instance of JfjochSettings from a dict
jfjoch_settings_from_dict = JfjochSettings.from_dict(jfjoch_settings_dict)

[Back to Model list] [Back to API list] [Back to README]