Welcome to katgpucbf’s documentation!

Contents:

• Introduction
  • MeerKAT and MeerKAT Extension
  • Radio Astronomy Correlators
  • This module
  • Controller
• Mathematical background
  • Frequencies
  • Complex voltages
  • Polyphase filter bank
  • Correlation products
  • Narrowband
  • Delay and phase compensation
• 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
  • 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 Format
    • Input
    • Output Packet Format
  • X-Engine Data Format
    • Input
    • Output Packet Format

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

Development and Testing

• Development Environment
  • Setting up a development environment
  • Pre-commit
  • Light-weight installation
  • Boiler-plate files
  • Preparing to raise a Pull Request
• Unit Testing
• Digitiser Packet Simulator
  • Usage
  • Signal specification
  • Design
• F-Engine Packet Simulator
• Qualification framework
  • Requirements
  • Configuration
  • Running
  • Post-processing
• Updating autotuning database
• Benchmarking
  • Multicast groups
  • Algorithm
• TODOs

Module reference

• katgpucbf package
  • Subpackages
    • katgpucbf.dsim package
    • katgpucbf.fgpu package
    • katgpucbf.fsim package
    • katgpucbf.xbgpu package
  • Submodules
    • katgpucbf.curand_helpers module
    • katgpucbf.mapped_array module
    • katgpucbf.meerkat module
    • katgpucbf.monitor module
    • katgpucbf.queue_item module
    • katgpucbf.recv module
    • katgpucbf.ringbuffer module
    • katgpucbf.send module
    • katgpucbf.spead module
    • katgpucbf.utils module
  • Module contents
    • DEFAULT_PACKET_PAYLOAD_BYTES
    • DEFAULT_TTL
    • MIN_SENSOR_UPDATE_PERIOD