leonarski_f
07c8b2ddd4
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015CeEGgpKdfkCTJb3YNMJcu (cherry picked from commit f8d07397288137dd5e3a0e5c101f2036d51228bd)
4.9 KiB
Documentation
The manuals and reference of Jungfraujoch and Rugnux, open-source software from the Paul Scherrer Institute for X-ray diffraction data. The front page has the overview and the downloads; this page is the map of the documentation.
Data processing
Rugnux
Processes a stored macromolecular diffraction dataset, a rotation sweep or serial stills, from the images to merged reflections: spot finding, indexing, integration, scaling and merging, with the space group, cell and resolution decided from the data and a report that says on what evidence; given an atomic model, it also places and refines it against the merge. One command, no parameters.
rugnux <diffraction image file>Linux · macOS · Windows · fast on an NVIDIA GPU, works without one
Desktop application
Jungfraujoch Viewer
Shows what is in a diffraction dataset: every image with its spots, predictions and resolution rings, per-image statistics over the sweep, grid-scan maps, and the same processing pipeline as Rugnux, run from a settings panel on the open file. Follows a live collection from a running Jungfraujoch broker.
Linux · macOS · Windows · Qt 6
Data acquisition
Jungfraujoch
The data-acquisition and real-time analysis system for the PSI JUNGFRAU and EIGER detectors, and for DECTRIS detectors through their control unit: an FPGA and GPU pipeline that takes the detector's frames at full rate, analyses them on the fly, streams them to the NXmx HDF5 writer and serves a web interface and REST API to the beamline.
Linux servers · AMD Alveo U55C FPGA · NVIDIA GPUs
Licence. Rugnux, the viewer and the Jungfraujoch
services are free software under the GNU General Public License v3 <LICENSE>; the
FPGA design is released under the CERN Open Hardware Licence v2, strongly reciprocal <FPGA_LICENSE>.
Both let anyone, in academia or industry, use, study and modify the
software and the hardware design at no charge, commercial use included;
what they ask is that a modified version which is passed on is shared
under the same terms. The released binaries bundle third-party
components under GPL-compatible licences, and the CUDA builds the NVIDIA
CUDA runtime under NVIDIA's own EULA: see the third-party notices <THIRD_PARTY_NOTICES>.
All pages
Everything a user of Rugnux or the viewer needs comes first; the
technical reference <TECHNICAL> holds the
algorithms, the file formats and streams, the interfaces and the FPGA
design. The names are explained in Naming <NAMING>, the releases in the changelog <CHANGELOG>.
Getting started <RUGNUX> Download <RUGNUX_DOWNLOAD> RUGNUX_OVERVIEW RUGNUX_INSTALL RUGNUX_FORMATS RUGNUX_TUTORIAL RUGNUX_REPORT RUGNUX_INTEGRATION RUGNUX_ADVANCED RUGNUX_MODEL_AND_REFERENCE Detector calibration <RUGNUX_CALIBRATION>
Using the viewer <JFJOCH_VIEWER> Download <VIEWER_DOWNLOAD>
Overview <JUNGFRAUJOCH> DEPLOYMENT REPOSITORIES RELEASE_CONTENTS JFJOCH_BROKER JFJOCH_WRITER WEB_FRONTEND MX software integration <SOFTWARE_INTEGRATION> TOOLS Python client <PYTHON_CLIENT>
TECHNICAL
ACKNOWLEDGEMENT LICENSE THIRD_PARTY_NOTICES NAMING CHANGELOG