Welcome to katgpucbf’s documentation!

Contents:

• Introduction
  • MeerKAT and MeerKAT Extension
  • Radio Astronomy Correlators
  • This package
  • Controller
• Mathematical conventions
  • Frequencies
  • Complex voltages
  • Delay and phase compensation
• Signal path overview
  • Channelisation and delay correction
  • Correlation
  • Beamforming
  • VLBI Resampling
• Changelog

Installation and Operation

• System requirements
  • Networking
  • BIOS settings
• Installation
  • Installation with Docker
  • Installation with pip
• Operation
  • katsdpcontroller
  • Starting the correlator
    • End-to-end correlator startup
    • Individual engine startup
  • Controlling the correlator
    • dsim
    • fgpu
    • xbgpu
    • vgpu
  • Shutting down the correlator
    • End-to-end correlator shutdown
    • Individual engine shutdown
• Monitoring
  • katcp sensors
  • Prometheus metrics
  • Event monitoring
• Data Interfaces
  • SPEAD Protocol
  • Packet Format
  • F-Engine Data Formats
    • Input
    • Output Packet Format
  • XB-Engine Data Formats
    • Input
    • X Output Packet Format
  • V-Engine Data Formats
    • Input
    • Output

Design

• DSP Engine Design
  • Terminology
  • Glossary
  • Operation
  • Common features
• F-Engine Design
  • Network receive
  • GPU Processing
  • Network transmit
  • Missing data handling
  • Narrowband
• XB-Engine design
  • Correlation
  • Beamforming
• V-Engine Design
  • Transmission

Development and Testing

• Development Guide
  • Setting up a development environment
  • Pre-commit
  • Light-weight installation
  • Boiler-plate files
  • Making a contribution
• Unit Testing
• Digitiser Packet Simulator
  • Usage
  • Signal specification
  • Design
• F-Engine Packet Simulator
• Qualification framework
  • Requirements
  • Configuration
  • Running
  • Post-processing
• Updating autotuning database
• Benchmarking
  • Algorithm
• TODOs

Module reference

• katgpucbf
  • katgpucbf package
    • Subpackages
    • Submodules
    • Module contents