Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
pirate_frb 1.0.0 documentation
pirate_frb 1.0.0 documentation
  • Home
  • Tex notes

User Guide

  • Installation
  • Introduction
  • Quick start
  • Developer notes
  • Writing a grouper
  • Build system
  • Hardware
  • CLI reference
  • 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
Back to top
View this page

File/network formats¶

Reference for pirate’s on-disk file formats and on-the-wire (network and RPC) protocols. The YAML pages render an example/config file; the others describe a wire protocol.

  • ASDF file format
  • X->FRB network protocol (v2)
  • xengine_metadata (v2)
  • dedispersion_config
  • dedispersion_plan
  • frb_server config
  • gRPC Protocol Definitions
Next
example_asdf_header.yml
Previous
CLI reference
Copyright © 2026, Kendrick Smith
Made with Sphinx and @pradyunsg's Furo