leonarski_f
8ff2abf3aa
docs/landing/ is a self-contained page (HTML, CSS, a little JS, no framework): a hero, a card per program, the download section with the archives of the newest release and the reader's own platform marked, the licence in one paragraph, light and dark. The jfjoch_downloads extension renders it into the HTML output root as index.html at the end of every Sphinx build, so it is served wherever the documentation is - Read the Docs, the gitea-pages branch and the broker's frontend bundle - and its download buttons are the same ones as on the Sphinx download pages, built from the configured release and repointed at the newest published one by the shared script. The Sphinx root page moves to documentation.html (root_doc), and the frontend's documentation frame opens that page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015CeEGgpKdfkCTJb3YNMJcu (cherry picked from commit 64cde61f0b941b3e8c99eaa9b74afeaa75aefc78)
4.8 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. 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