Pirate - Perimeter Institute RAdio Transient Engine

An experimental GPU-based fast transient search for CHORD.

• Tree dedispersion tex notes (PDF) – mathematical details of the search.

User Guide

• Installation
• Introduction
• Quick start
  • Run unit tests
  • Running a toy search
  • Running a production search (cf00/cf05)
• Developer notes
  • ksgpu helper library
  • Chunks, batches, frames, and segments
  • Allocators
  • Networking
  • File writing
  • Software engineering philosophy
• Writing a grouper
  • Example code
  • FrbGrouper context manager
  • Data arrays and GpuDedisperserOutputs context manager
• Build system
  • Autogenerated kernels
  • gRPC
  • File Structure
  • Overriding Makefile variables
• Hardware
  • Nodes
  • Full CHORD network (future)
  • DRAO backend
• CLI reference
  • Subcommands
  • Detailed usage
• File/network formats
  • ASDF file format
  • X->FRB network protocol (v2)
  • xengine_metadata (v2)
  • dedispersion_config
  • dedispersion_plan
  • frb_server config
  • gRPC Protocol Definitions
• Python class reference
  • FrbGrouper
  • FrbSifterClient
  • FrbSifterEvents
  • GpuDedisperserOutputs
• LLM context files
  • C++ guidelines
  • GPU kernels
  • Pybind11
  • Writing sphinx-friendly docstrings
  • Thread-Backed Class Pattern
  • CudaEventRingbuf