Documentation ============= .. raw:: html

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 data: 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 goes on to a refined structure and maps: the model is placed (rigid body or molecular replacement) and refined against the merge. One command, no parameters.

rugnux <diffraction image file>
   rugnux <diffraction image file> <CIF/PDB model 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 :doc:`GNU General Public License v3 `; the FPGA design is released under the :doc:`CERN Open Hardware Licence v2, strongly reciprocal `. 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 :doc:`third-party notices `. All pages --------- Everything a user of Rugnux or the viewer needs comes first; the :doc:`technical reference ` holds the algorithms, the file formats and streams, the interfaces and the FPGA design. The names are explained in :doc:`Naming `, the releases in the :doc:`changelog `. .. raw:: html
.. toctree:: :maxdepth: 1 :caption: Rugnux Getting started Download RUGNUX_OVERVIEW RUGNUX_INSTALL RUGNUX_FORMATS RUGNUX_TUTORIAL RUGNUX_REPORT RUGNUX_INTEGRATION RUGNUX_ADVANCED RUGNUX_MODEL_AND_REFERENCE Detector calibration .. toctree:: :maxdepth: 1 :caption: Jungfraujoch Viewer Using the viewer Download .. toctree:: :maxdepth: 1 :caption: Jungfraujoch Overview DEPLOYMENT REPOSITORIES RELEASE_CONTENTS JFJOCH_BROKER JFJOCH_WRITER WEB_FRONTEND MX software integration TOOLS Python client .. toctree:: :maxdepth: 1 :caption: Reference TECHNICAL .. toctree:: :maxdepth: 1 :caption: Project ACKNOWLEDGEMENT LICENSE THIRD_PARTY_NOTICES NAMING CHANGELOG .. raw:: html