leonarski_fandClaude Fable 5
70c4d871b6
- Capitalize Rugnux as a proper noun throughout the prose; the command stays lowercase `rugnux` in code font. RUGNUX_OVERVIEW.md is retitled "What Rugnux does". - ACKNOWLEDGEMENT.md cites the raw-data repositories only: dataset counts and DOI prefixes moved out (EXTERNAL_TEST_DATA.md owns them), the ESRF data portal gains its citation (Dimper et al. 2019), and MXRDR remains name + link - it has no canonical citation paper. - RUGNUX_FORMATS.md: the CCD formats (marCCD, SMV) are supported as-is with very limited scope, and per-panel XFEL data is not read. - Fix wrong facts a reader would act on: nonexistent `make jfjoch` targets, invalid udev rules, PUSH sockets documented as PULL, swapped writer width/height, underload semantics, the transposed pixel-mask numpy example (the server checks width and height separately), the Durin/Neggia mask-bit table, FPGA threshold register addresses and the mailbox bit field, the I2C core's document number (PG090), an inverted MODEL_FIT_SIGMA formula, a self-inconsistent worked report example, and 11 cross-page anchors whose slugs carry MyST section numbers. - Unify CC1/2 spelling in prose; math notation and report keys unchanged. - Sweep grammar, typos and editing residue across the FPGA, deployment, streaming and analysis pages, including historical CHANGELOG typos. - rugnux_cli.cpp: the -S usage/error examples pair 96 with P43212; 92 names a different group. - Root THIRD_PARTY_NOTICES.md: scope the GPL-compatibility claim (CUDA EULA) and the vendored-table intro (traccc); the docs copy regenerates via update_version.sh. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
59 lines
3.5 KiB
Markdown
59 lines
3.5 KiB
Markdown
# Linux package repositories
|
|
For convenience, we are providing package repositories, in versions including and excluding CUDA linking.
|
|
We recommend installing the Jungfraujoch viewer from a `nocuda` repository (published in the `slsdet8` flavour only) and the remaining packages from a `cuda12`/`cuda13` repository.
|
|
|
|
The repository name encodes two choices: the [slsDetectorPackage](DETECTORS.md) version the packages
|
|
were built against (`slsdet8` = 8.0.2, `slsdet9` = 9.2.0 — it must match the detector firmware) and
|
|
whether CUDA is linked in. What ends up inside each package, and what it needs on the target
|
|
machine, is described in [Release contents](RELEASE_CONTENTS.md).
|
|
|
|
## RHEL based systems
|
|
|
|
For RHEL systems we provide the following repositories:
|
|
|
|
| RHEL version | slsDetectorPackage | CUDA | Repository file |
|
|
|--------------|--------------------|------|------------------------------------------------------------------------|
|
|
| 8.x | 8.0.2 | 12.x | https://gitea.psi.ch/api/packages/mx/rpm/centos/el8/slsdet8-cuda12.repo |
|
|
| 8.x | 9.2.0 | 12.x | https://gitea.psi.ch/api/packages/mx/rpm/centos/el8/slsdet9-cuda12.repo |
|
|
| 8.x | 8.0.2 | - | https://gitea.psi.ch/api/packages/mx/rpm/centos/el8/slsdet8-nocuda.repo |
|
|
| 9.x | 8.0.2 | 13.x | https://gitea.psi.ch/api/packages/mx/rpm/centos/el9/slsdet8-cuda13.repo |
|
|
| 9.x | 9.2.0 | 13.x | https://gitea.psi.ch/api/packages/mx/rpm/centos/el9/slsdet9-cuda13.repo |
|
|
| 9.x | 8.0.2 | - | https://gitea.psi.ch/api/packages/mx/rpm/centos/el9/slsdet8-nocuda.repo |
|
|
|
|
To install the repository, run:
|
|
|
|
```bash
|
|
dnf config-manager --add-repo https://gitea.psi.ch/api/packages/mx/rpm/centos/el8/slsdet8-cuda12.repo
|
|
```
|
|
RPMs are signed by the Gitea package registry as they are uploaded. If your system cannot verify the
|
|
signature, set `gpgcheck=0` in the repository file or install with `--nogpgcheck`.
|
|
|
|
We provide the following packages in the repository:
|
|
* jfjoch — broker, web frontend, FPGA and detector command-line tools
|
|
* jfjoch-driver-dkms — PCIe kernel-module source, built by DKMS
|
|
* jfjoch-writer — HDF5 writer service
|
|
* jfjoch-viewer — desktop viewer and the XDS plugin
|
|
* Rugnux — [offline analysis CLI](RUGNUX.md), independent of the acquisition stack
|
|
|
|
Note that `rugnux` is named without the `jfjoch-` prefix, matching the program and the release
|
|
archive. Up to 1.0.0-rc.163 it was part of `jfjoch-viewer`; the package declares that move, so
|
|
installing it upgrades an older viewer rather than colliding with it.
|
|
|
|
## Ubuntu based systems
|
|
|
|
For Ubuntu systems, we also provide the following repositories:
|
|
```
|
|
sudo curl https://gitea.psi.ch/api/packages/mx/debian/repository.key -o /etc/apt/keyrings/gitea-mx.asc
|
|
echo "deb [signed-by=/etc/apt/keyrings/gitea-mx.asc] https://gitea.psi.ch/api/packages/mx/debian $distribution $component" | sudo tee -a /etc/apt/sources.list.d/gitea.list
|
|
sudo apt update
|
|
```
|
|
|
|
`$distribution` uses Ubuntu names `jammy` (22.04) and `noble` (24.04). `$component` can be set to either `cuda13` or `nocuda`.
|
|
Only slsDetectorPackage 8.0.2 is built for Ubuntu.
|
|
|
|
The same five packages as above are provided: `jfjoch`, `jfjoch-driver-dkms`, `jfjoch-writer`,
|
|
`jfjoch-viewer` and `rugnux`. Up to 1.0.0-rc.160 the first of them was misnamed `jfjoch-jfjoch`; the current
|
|
package replaces it, so `apt upgrade` handles the rename.
|
|
|
|
Ubuntu packages currently undergo only very limited testing.
|