diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 11ae9f932..e4a4e0bcf 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -37,7 +37,7 @@ Frontend web user interface has to be built separately with: $ cd build $ make frontend ``` -Frontend files (.html and .js) will be placed in `frontend/dist` (outside of `build/` directory!) and has to be copied to a general location, e.g. `/usr/local/jfjoch/frontend` or `/opt/jfjoch/frotend`. +Frontend files (.html and .js) will be placed in `frontend/dist` (outside of `build/` directory!) and has to be copied to a general location, e.g. `/usr/local/jfjoch/frontend` or `/opt/jfjoch/frontend`. ## Flash the U55C FPGA card with a proper image and install Linux kernel driver. @@ -58,7 +58,7 @@ LnkSta: Speed 16GT/s (ok), Width x8 (ok) (...) ``` -3. Download the MCS image from release files or build it using Vivado (WARNING! building time can be about 8 hours and doesn't allways reach correct timing). +3. Download the MCS image from release files or build it using Vivado (WARNING! building time can be about 8 hours and doesn't always reach correct timing). 4. Flash the card with `xbflash.qspi` tool (part of Jungfraujoch). For fresh card use: ``` sudo xbflash.qspi --primary --card --bar-offset 0x1f06000 diff --git a/docs/DETECTORS.md b/docs/DETECTORS.md index f52dcdd9d..0aea6d09a 100644 --- a/docs/DETECTORS.md +++ b/docs/DETECTORS.md @@ -1,7 +1,7 @@ # Supported detectors ## PSI detectors -Jungfraujoch supports PSI JUNGFRAU and PSI EIGER detectors. Jungfruajoch controls the detector via statically compiled `slsDetectorPackage` into its source code. +Jungfraujoch supports PSI JUNGFRAU and PSI EIGER detectors. Jungfraujoch controls the detector via statically compiled `slsDetectorPackage` into its source code. The detector firmware must match the `slsDetectorPackage` version used in Jungfraujoch. The default is 8.0.2; 9.2.0 is built with the `SLS9=ON` CMake option and published in the `slsdet9` [package repositories](REPOSITORIES.md). diff --git a/docs/FPGA_DATA_ANALYSIS.md b/docs/FPGA_DATA_ANALYSIS.md index a392f0b45..a9205fe70 100644 --- a/docs/FPGA_DATA_ANALYSIS.md +++ b/docs/FPGA_DATA_ANALYSIS.md @@ -33,7 +33,7 @@ Corrections were implemented according to formulas developed by [Jensen et al. ( Given FPGA limitations, split-pixels cannot be implemented and number of bins is limited as 2048 per detector module. This way 2D azimuthal integration, as needed for example by SAS-TT, cannot be currently implemented with the FPGA card and needs to be done on a CPU. -One needs to be careful with per-pixel corrections - their acceptable range is constrained by 16-bit pixed point integer implementation +One needs to be careful with per-pixel corrections - their acceptable range is constrained by 16-bit fixed point integer implementation and is tuned for standard SAXS/WAXS range. As with ROIs, azimuthal integration is also available on CPU through the shared analysis library, @@ -66,7 +66,7 @@ ROIs are not specific to the FPGA path. The same ROI definitions — box, circle engine, so ROI statistics are produced both for the FPGA-accelerated JUNGFRAU/PSI workflow and for detectors driven through DECTRIS SIMPLON (e.g. EIGER), which have no FPGA acquisition path. -## Pixel statisitics +## Pixel statistics The following statistics are collected for each module: * Number of masked pixels * Number of saturated pixels (excl.masked) diff --git a/docs/HARDWARE.md b/docs/HARDWARE.md index 432cb2f2c..e1be8bb0c 100644 --- a/docs/HARDWARE.md +++ b/docs/HARDWARE.md @@ -7,12 +7,12 @@ Operating Jungfraujoch requires the following: 4. (optionally) 100G switch to connect FPGA and the detector Unfortunately, at the moment it is not possible to purchase server configuration from a major vendor that would include -AMD FPGA boards. Therefore, the two has to be purchases separately. This might have impact on the warranty for the hardware +AMD FPGA boards. Therefore, the two have to be purchased separately. This might have impact on the warranty for the hardware and has to be clarified with the vendor. PSI only supports the system on the best effort basis and doesn't take any responsibility for warranty limitations for operating FPGA boards in the server. Having said this - we didn't encounter any hardware issues so far. ## High performance server -PSI is using HPE DL380 Gen11 servers are the moment to operate Jungfraujoch systems. However, this is because of general +PSI is using HPE DL380 Gen11 servers at the moment to operate Jungfraujoch systems. However, this is because of general preference for this vendor, there is no Jungfraujoch-specific reason to buy from this vendor. We do expect that system from any other vendor with similar specification should work as well. diff --git a/docs/HDF5.md b/docs/HDF5.md index 63defde82..d514a6122 100644 --- a/docs/HDF5.md +++ b/docs/HDF5.md @@ -118,7 +118,7 @@ holds *all* the derived analysis (everything in §4) plus a virtual view of the raw images — without duplicating terabytes of data. This is a particularly FAIR-friendly artefact: it can be shared or archived alongside (or instead -of) the raw data to convey what is in a dataset and how it processed, while the `/entry/data/data` +of) the raw data to convey what is in a dataset and how it was processed, while the `/entry/data/data` VDS still resolves to the original images when they are available. `rugnux` can also process an equally-spaced *subset* of images (start/end/stride), producing a down-sampled reference set.