Files
Jungfraujoch/docs/index.rst
T
leonarski_fandClaude Opus 5 46930142dd docs: write down what a release ships
Nothing said what is in a release or what it needs of the machine it lands on: that the
Linux binaries are built -march=x86-64-v3 and the Windows ones /arch:AVX, so each has a
CPU floor; that the portable .tgz is built on RHEL 8 for its glibc; that the Windows
installer is MSVC (Visual Studio 2026), CUDA 13.3, Qt 6.11 and carries the Qt runtime;
and above all what the CUDA variants need. Only cuFFT is linked dynamically, and it has
no link-time dependency on the driver library, so a CUDA build starts on a machine with
no NVIDIA GPU at all and falls back to the CPU path - as long as cuFFT can be loaded,
which the .tgz and the installer arrange by shipping it and the distribution packages
arrange through the distribution's own CUDA packages. Collected into a new page rather
than scattered over the install instructions.

The repository page had the RHEL 9 rows pointing at el8 paths under the wrong slsdet
number, no rows at all for the two slsdet9 repositories the pipeline uploads, a driver
package named jfjoch-driver where it is jfjoch-driver-dkms, and a note that RPMs are
unsigned from before the pipeline started uploading them with sign=true.

The FPGA page had a paragraph that stopped mid-sentence, in the middle of a link, and a
section describing a firmware build triggered by commit message. The firmware is stable
and carried from version to version now.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-03 20:53:19 +02:00

84 lines
1.5 KiB
ReStructuredText

.. image:: jfjoch.png
:width: 256
:align: left
PSI Jungfraujoch
================
Jungfraujoch is data acquisition and on-the-fly analysis system developed by the `Paul Scherrer Institut <https://www.psi.ch>`__.
It can be currently used with PSI and DECTRIS detectors.
Jungfraujoch is distributed under the GPLv3 license.
.. toctree::
:maxdepth: 1
:caption: General
ACKNOWLEDGEMENT
LICENSE
THIRD_PARTY_NOTICES
DETECTORS
HARDWARE
SOFTWARE
VERSIONING
DEPLOYMENT
RELEASE_CONTENTS
REPOSITORIES
NAMING
CHANGELOG
.. toctree::
:maxdepth: 1
:caption: Software
JFJOCH_BROKER
JFJOCH_WRITER
RUGNUX
JFJOCH_VIEWER
SOFTWARE_INTEGRATION
TOOLS
.. toctree::
:maxdepth: 1
:caption: FPGA
FPGA
FPGA_LICENSE
FPGA_DESIGN
FPGA_NETWORK
FPGA_PCIE_DRIVER
FPGA_SETTINGS
FPGA_DATA_ANALYSIS
.. toctree::
:maxdepth: 1
:caption: Reference
DETECTOR_GEOMETRY
CPU_DATA_ANALYSIS
OPENAPI
OPENAPI_SPECS
CBOR
HDF5
IMAGE_STREAM
PIXEL_MASK
WEB_FRONTEND
TESTS
.. toctree::
:maxdepth: 1
:caption: OpenAPI Python client
python_client/README
python_client/docs/DefaultApi
.. The remaining python_client/docs/*.md pages are generated per-model reference
files linked from the client README/DefaultApi; include them in a hidden glob
toctree so they are built without each one warning about being orphaned.
.. toctree::
:hidden:
:glob:
python_client/docs/*