PSI Jungfraujoch

General

• Acknowledgements
• License
  • GNU GENERAL PUBLIC LICENSE
  • Jungfraujoch exceptions to GPL
• Supported detectors
• Hardware requirements
  • High performance server
  • FPGA
  • GPUs
  • Network switch
• Software requirements
  • Operating system
  • Software dependencies
• Semantic versioning
• Deployment
  • Install main Jungfraujoch code and frontend web interface
  • Flash the U55C FPGA card with a proper image and install Linux kernel driver.
  • Install Jungfraujoch writer
  • Install Jungfraujoch image viewer
  • Install Jungfraujoch Python client
• Changelog
  • 1.0.0-rc.64
  • 1.0.0-rc.63
  • 1.0.0-rc.62
  • 1.0.0-rc.61
  • 1.0.0-rc.60
  • 1.0.0-rc.59
  • 1.0.0-rc.58
  • 1.0.0-rc.57
  • 1.0.0-rc.56
  • 1.0.0-rc.55
  • 1.0.0-rc.54
  • 1.0.0-rc.53
  • 1.0.0-rc.52
  • 1.0.0-rc.51
  • 1.0.0-rc.50
  • 1.0.0-rc.49
  • 1.0.0-rc.48
  • 1.0.0-rc.47
  • 1.0.0-rc.46
  • 1.0.0-rc.45
  • 1.0.0-rc.44
  • 1.0.0-rc.43
  • 1.0.0-rc.42
  • 1.0.0-rc.41
  • 1.0.0-rc.40
  • 1.0.0-rc.39
  • 1.0.0-rc.38
  • 1.0.0-rc.37
  • 1.0.0-rc.36
  • 1.0.0-rc.35
  • 1.0.0-rc.34
  • 1.0.0-rc.33
  • 1.0.0-rc.32
  • 1.0.0-rc.31
  • 1.0.0-rc.30
  • 1.0.0-rc.29
  • 1.0.0-rc.28
  • 1.0.0-rc.27
  • 1.0.0-rc.26
  • 1.0.0-rc.25
  • 1.0.0-rc.24

Software

• jfjoch_broker
  • External interfaces
  • Broker configuration
  • Setting up a local test for Jungfraujoch
• jfjoch_writer
  • Acknowledgements
  • Running directory
  • Usage
  • HTTP interface
  • Republish
  • Overwriting files
  • Finalized files information
  • HDF5 file structure
  • Other formats (CBF and TIFF)
• Tools
  • jfjoch_pcie_status
  • jfjoch_pcie_clear_net_counters
  • jfjoch_pcie_net_cfg
  • jfjoch_hdf5_tools
  • jfjoch_offline_process
  • jfjoch_udp_simulator
  • jfjoch_pcie_read_register
• Resolution estimation (ML)
  • Installation
  • Execution
  • Known issues

FPGA

• FPGA smartNIC
  • Hardware
  • Building firmware
• FPGA license
  • CERN Open Hardware Licence Version 2 - Strongly Reciprocal
• FPGA data flow
• FPGA network
  • Transceivers
  • Switch configuration
  • Network LEDs
  • Network stack
• FPGA PCIe driver
  • Compilation
  • Installation
  • Loading driver into kernel
  • Ownership of the character devices
  • DKMS
  • Driver parameters
  • Exchange buffers
  • Known problems
  • CMake file
  • Character device access
  • Sysfs access
  • RHEL 9.5+ issue
• FPGA advanced reference
  • Register map
  • AXI Mailbox
  • HBM memory
• FPGA data analysis
  • Pixel mask
  • ADU histogram
  • JUNGFRAU conversion
  • Frame summation
  • Pixel thresholding
  • Azimuthal integration
  • Spot finding
  • Region-of-interest (ROI) integration
  • Pixel statisitics
  • Sqrt compression

Reference

• OpenAPI
  • OpenAPI specs
  • Python client
• OpenAPI specification
• CBOR messages
  • Start message
  • Image message
  • Metadata message
  • End message
  • Calibration message
  • User data
• ZeroMQ socket
  • Image stream
  • Preview stream
  • Metadata stream
• Pixel mask
  • Mask format
  • Custom user mask
• Web frontend
• Tests

OpenAPI Python client

• jfjoch-client
• jfjoch_client.DefaultApi
• cancel_post
• config_azim_int_get
• config_azim_int_put
• config_detector_get
• config_detector_put
• config_file_writer_get
• config_file_writer_put
• config_image_format_conversion_post
• config_image_format_get
• config_image_format_put
• config_image_format_raw_post
• config_indexing_get
• config_indexing_put
• config_instrument_get
• config_instrument_put
• config_internal_generator_image_put
• config_internal_generator_image_tiff_put
• config_mask_get
• config_mask_tiff_get
• config_roi_get
• config_roi_put
• config_select_detector_get
• config_select_detector_put
• config_spot_finding_get
• config_spot_finding_put
• config_user_mask_get
• config_user_mask_put
• config_user_mask_tiff_get
• config_user_mask_tiff_put
• config_zeromq_metadata_get
• config_zeromq_metadata_put
• config_zeromq_preview_get
• config_zeromq_preview_put
• deactivate_post
• detector_status_get
• fpga_status_get
• image_buffer_clear_post
• image_buffer_image_cbor_get
• image_buffer_image_jpeg_get
• image_buffer_image_png_get
• image_buffer_image_tiff_get
• image_buffer_start_cbor_get
• image_buffer_status_get
• initialize_post
• pedestal_post
• preview_pedestal_tiff_get
• preview_plot_get
• result_scan_get
• start_post
• statistics_calibration_get
• statistics_data_collection_get
• statistics_get
• status_get
• trigger_post
• version_get
• wait_till_done_post
• xfel_event_code_get
• xfel_pulse_id_get