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 Python client
• Changelog
  • 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
  • Finalized files information
  • HDF5 file structure
• Tools
  • jfjoch_pcie_status
  • jfjoch_pcie_clear_net_counters
  • jfjoch_pcie_net_cfg
  • jfjoch_hdf5_tools
  • jfjoch_offline_process
  • jfjoch_azint
  • jfjoch_udp_simulator
  • jfjoch_pcie_read_register

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
• FPGA advanced reference
  • Register map
  • AXI Mailbox
  • HBM memory

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_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_start_cbor_get
• image_buffer_status_get
• initialize_post
• pedestal_post
• plot_azim_int_get
• plot_bkg_estimate_get
• plot_error_pixel_get
• plot_image_collection_efficiency_get
• plot_indexing_rate_get
• plot_indexing_unit_cell_angle_get
• plot_indexing_unit_cell_get
• plot_packets_received_get
• plot_receiver_delay_get
• plot_receiver_free_send_buffers_get
• plot_roi_max_count_get
• plot_roi_sum_get
• plot_roi_valid_pixels_get
• plot_spot_count_get
• plot_strong_pixel_get
• preview_calibration_tiff_get
• preview_image_jpeg_get
• preview_image_jpeg_post
• preview_image_tiff_get
• preview_pedestal_tiff_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