Files
Jungfraujoch/docs/VIEWER_DOWNLOAD.md
T
leonarski_f 9c543f60b6 docs: home page with the three programs, download pages for rugnux and the viewer, technical reference grouped below
The home page introduces Rugnux, the viewer and the acquisition system in three cards, with the
licence stated once, and the sidebar is regrouped by program: what a user of Rugnux or the viewer
needs comes first, and the algorithms, formats, interfaces, hardware and FPGA pages sit under one
collapsed "Technical reference" hub (TECHNICAL.md). No page moves, so every existing URL stays.

Download pages (RUGNUX_DOWNLOAD.md, VIEWER_DOWNLOAD.md) are rendered by a small Sphinx extension
(docs/_ext/jfjoch_downloads.py) from the `release` in conf.py, which update_version.sh rewrites,
so no version string on them is maintained by hand; a script then asks the Gitea API for the
newest published release and repoints the buttons at its assets, naming any archive that release
does not carry. Without network access the build-time links stand. JUNGFRAUJOCH.md is the
landing page of the acquisition side with its install pointers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015CeEGgpKdfkCTJb3YNMJcu
(cherry picked from commit 050442592504ce879dc51d78b6d3d1c58268a800)
2026-10-25 07:20:28 +01:00

2.6 KiB

Download the Jungfraujoch Viewer

jfjoch_viewer is a standalone desktop application, pre-built for Linux, macOS and Windows with the Qt runtime included. The links point at the current release; the full list of what each release ships is on its release page.

.. jfjoch-downloads:: viewer

On a machine with an NVIDIA GPU take the GPU build: its embedded spot finding, indexing and integration run on the card, and it also starts on a machine without one, on the CPU. The CPU only build runs the same pipeline at lower throughput and is the smaller download. A V100 needs the CUDA 12 build; the CUDA 13 builds start at Turing (T4) — see Release contents.

After downloading

Linux. The archive has no top-level directory, so unpack it into a directory of its own, then run the program from its bin/:

mkdir -p ~/jfjoch_viewer
tar xzf jfjoch_viewer-<version>-linux-cuda12.tgz -C ~/jfjoch_viewer
~/jfjoch_viewer/bin/jfjoch_viewer dataset_master.h5

The archive also carries the desktop entry, icon and D-Bus service file under share/, which the desktop picks up when the archive is unpacked into a prefix it searches, such as /usr/local. The Linux repositories carry the viewer as the jfjoch-viewer package as well (package repositories).

macOS. Open the disk image and drag jfjoch_viewer onto the Applications shortcut next to it. The image is signed and notarized by Apple, so it opens like any other application. Apple Silicon only; Intel Macs are not supported.

Windows. Run the installer. The CUDA and CPU variants share one install directory and replace each other, and are told apart in Add/Remove Programs as Jungfraujoch (CUDA) and Jungfraujoch (CPU).

Then File ▸ Open a Jungfraujoch or NXmx master file, a _process.h5 written by Rugnux, or any frame of a miniCBF, marCCD or SMV sweep; File ▸ Open HTTP follows a live collection from a running broker. jfjoch_viewer is the manual, with a guided tour of the four views most people use.

From source

The viewer builds on Linux, Windows (MSVC and CUDA) and macOS; Qt 6 is the one dependency that has to be installed first, everything else is fetched by the configure. See Building from source on Windows and on macOS; on Linux configure the full tree with -DJFJOCH_VIEWER_BUILD=ON (Deployment).