# Technical reference

The pages that describe how things work rather than how to use them: the algorithms behind the
analysis, the file formats and streams, the programming interfaces, the hardware and the FPGA
design. Nothing here is needed to run Rugnux or the viewer; all of it is needed to build on them.

```{toctree}
:caption: Data analysis
:maxdepth: 1

CPU_DATA_ANALYSIS
CPU_DATA_ANALYSIS_IMAGE
CPU_DATA_ANALYSIS_INDEXING
CPU_DATA_ANALYSIS_INTEGRATION
CPU_DATA_ANALYSIS_DECISIONS
CPU_DATA_ANALYSIS_REFINEMENT
GPU_DATA_ANALYSIS
DETECTOR_GEOMETRY
RUGNUX_BENCHMARKING
EXTERNAL_TEST_DATA
EXTERNAL_TEST_DATA_STILLS
```

```{toctree}
:caption: Formats and interfaces
:maxdepth: 1

HDF5
PIXEL_MASK
IMAGE_STREAM
CBOR
OPENAPI
OPENAPI_SPECS
```

```{toctree}
:caption: Hardware and FPGA
:maxdepth: 1

HARDWARE
SOFTWARE
DETECTORS
FPGA
FPGA_DESIGN
FPGA_DATA_ANALYSIS
FPGA_NETWORK
FPGA_PCIE_DRIVER
FPGA_SETTINGS
FPGA_LICENSE
```

```{toctree}
:caption: Development
:maxdepth: 1

TESTS
VERSIONING
SECURITY
```