Files
Jungfraujoch/docs/index.rst
T
leonarski_fandFilip Leonarski 19b135186d
Build Packages / Create release (push) Successful in 7s
Build Packages / build:portable:macos-arm64:nocuda (push) Successful in 4m56s
Build Packages / build:rugnux:linux-aarch64:cuda (push) Successful in 9m10s
Build Packages / build:portable:linux-x86_64:nocuda (push) Successful in 13m51s
Build Packages / build:portable:linux-x86_64:cuda (push) Successful in 16m56s
Build Packages / build:jfjoch:rocky8:nocuda (push) Successful in 20m59s
Build Packages / build:portable:windows-x86_64:nocuda (push) Successful in 21m25s
Build Packages / build:jfjoch:rocky9:nocuda (push) Successful in 21m17s
Build Packages / build:jfjoch:ubuntu2204:nocuda (push) Successful in 14m14s
Build Packages / HDF5 consumer tests (DIALS, XDS) (push) Successful in 25m59s
Build Packages / build:portable:windows-x86_64:cuda (push) Successful in 25m48s
Build Packages / build:jfjoch:ubuntu2404:nocuda (push) Successful in 15m52s
Build Packages / build:jfjoch:rocky8:cuda-sls9 (push) Successful in 19m33s
Build Packages / Generate python client (push) Successful in 29s
Build Packages / Build documentation (push) Successful in 1m19s
Build Packages / build:jfjoch:ubuntu2204:cuda (push) Successful in 20m49s
Build Packages / build:jfjoch:rocky9:cuda-sls9 (push) Successful in 25m31s
Build Packages / build:jfjoch:rocky8:cuda (push) Successful in 25m24s
Build Packages / build:jfjoch:rocky9:cuda (push) Successful in 26m5s
Build Packages / build:jfjoch:ubuntu2404:cuda (push) Successful in 22m19s
Build Packages / Unit tests (push) Failing after 2h28m24s
Build Packages / Validation Battery (push) Successful in 40m33s
v1.0.0-rc.175 (#85)
* Rugnux: Processes a collection live while jfjoch_broker writes it (`rugnux <master.h5> <broker URL>`).
* Rugnux: Processing starts on the first images and confirms its choices once all are in, so analysis can begin during collection.
* Rugnux: Faster processing, especially on servers with several GPUs and CPU sockets and on computers without a GPU (`--no-gpu`, macOS).
* Rugnux: Uses much less GPU memory, so large data sets stay on the GPU of smaller cards, and a data set too large for the card is processed on the CPU instead.
* Rugnux: On macOS, Bragg integration runs on the Apple GPU.
* Rugnux: Better handling of twinning and pseudo-symmetry, with the twin hypothesis written as `<prefix>_twin_<SG>.mtz`, and a wrong `--model` no longer confirms the data or decides the hand.
* Rugnux: `--model` accepts predicted (AlphaFold) models and falls back to molecular replacement when the model is not placed as a rigid body (experimental `--mr` forces it), settling space group, hand and twinning and writing a different answer as `<prefix>_mr.mtz`.
* Rugnux: Molecular replacement is faster and settles the space group in more cases with several copies in the asymmetric unit.
* Rugnux: Deposition-ready mmCIF, a richer report, and numbered steps on the terminal with the full log in `<prefix>_log.txt`; `_P1.mtz`, `--estimate-beam-center` and `--beam-center-search` are removed.
* Rugnux: The beam-stop shadow is found correctly on tilted detectors.
* Rugnux: Stills files that record a stationary goniometer axis get the default stills geometry refinement.
* jfjoch_viewer: "Analyze dataset" uses the same defaults as a bare `rugnux <file>`, and shows the results of processed CBF, marCCD and SMV sweeps.
* jfjoch_viewer: The Files panel refreshes on F5 and every few seconds, and the plot type and other selections stay put during live collection.
* jfjoch_writer: Memory stays bounded and old data files are closed efficiently on long runs, any failure ends the run in an error state the broker is told about, and the master file appears only after its data files; the ZeroMQ pusher logs when a stalled writer makes it drop images.
* Fixes: The TCP image pusher no longer blocks the broker's receiver, GPU out-of-memory failures stop with a clear message, and the XDS plugin masks module and chip edges.

---------

Co-authored-by: Filip Leonarski <jungfrau@filips-mac-mini.home>
Reviewed-on: #85
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-10-16 15:34:43 +02:00

94 lines
1.7 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.
Its data-processing half is **rugnux** — start at :doc:`rugnux <RUGNUX>` to process a stored
dataset, and at :doc:`the broker <JFJOCH_BROKER>` to acquire one.
Jungfraujoch is distributed under the GPLv3 license.
.. toctree::
:maxdepth: 1
:caption: rugnux — data processing
RUGNUX
RUGNUX_OVERVIEW
RUGNUX_INSTALL
RUGNUX_FORMATS
RUGNUX_TUTORIAL
RUGNUX_INTEGRATION
RUGNUX_REPORT
RUGNUX_ADVANCED
RUGNUX_MODEL_AND_REFERENCE
RUGNUX_CALIBRATION
RUGNUX_BENCHMARKING
CPU_DATA_ANALYSIS
CPU_DATA_ANALYSIS_IMAGE
CPU_DATA_ANALYSIS_INDEXING
CPU_DATA_ANALYSIS_INTEGRATION
CPU_DATA_ANALYSIS_DECISIONS
GPU_DATA_ANALYSIS
.. toctree::
:maxdepth: 1
:caption: Jungfraujoch — acquisition
JFJOCH_BROKER
JFJOCH_WRITER
JFJOCH_VIEWER
SOFTWARE_INTEGRATION
TOOLS
DEPLOYMENT
DETECTORS
HARDWARE
SOFTWARE
.. 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
OPENAPI
OPENAPI_SPECS
PYTHON_CLIENT
CBOR
HDF5
IMAGE_STREAM
PIXEL_MASK
WEB_FRONTEND
TESTS
.. toctree::
:maxdepth: 1
:caption: Project
ACKNOWLEDGEMENT
EXTERNAL_TEST_DATA
LICENSE
THIRD_PARTY_NOTICES
VERSIONING
SECURITY
RELEASE_CONTENTS
REPOSITORIES
NAMING
CHANGELOG