pleb - The EPTA Data Combination Pipeline

Get Started

• Overview
  • Pulsar timing context
  • Radio telescopes and backends
  • Where to start
• Installation
  • Python requirements
  • Optional extras
  • tempo2 and timing files
• Quickstart
  • Config Layout Quick Reference
  • Minimal configuration
  • Run the pipeline
  • CLI overrides
  • Optional QC stage
  • Declarative relabel rules
  • Declarative overlap rules
  • Per-backend PQC profiles
  • TOML-configurable outlier strategies
  • Compact PDF report
  • Exact-overlap keep/drop catalog
  • Next steps

User Guides

• Configuration Guide
  • Scope and Positioning
  • How To Read This Chapter
  • Mental Model
  • Directory Layout (Current Canonical)
  • Run Profiles
  • Workflows and Step Configs
  • Catalog Files
  • Rule Files
  • Schemas
  • Generated State
  • Composition and Precedence
  • Path Strategy
  • Naming and Versioning Conventions
  • Minimal Patterns
  • Reproducibility and Lockfiles
  • Migration Notes (Old -> Current Layout)
  • Common Failure Modes
  • Operational Best Practices
  • Config Authoring Checklist
  • Cross References
  • Configuration by Lifecycle Phase
  • Detailed Layout Inventory
  • Configuration Design Patterns
  • Configuration Anti-Patterns and Corrections
  • Policy Ownership and Review Model
  • Auditing and Traceability
  • Scenario Playbooks
  • Path Migration Cookbook
  • Validation Strategy for Config Changes
  • What To Put In PR Descriptions For Config Changes
  • Reference Appendices
• Configuration Layout
  • Purpose
  • Canonical Tree
  • Directory Roles
  • What Goes Where
  • Naming Guidelines
  • Path Conventions
  • Composition Model
  • Workflow Layout Pattern
  • Catalog vs Rule Boundary
  • Generated State Policy
  • Migration Map
  • Maintenance Checklist
  • Cross References
• PLEB Deep Dive
  • Quick overview
  • How to read the deep dive
  • Deep-dive chapters
  • Related docs
• Running Pleb
  • Overview of modes
  • Mode 1: Direct CLI (no settings file)
  • Mode 2: CLI with a settings file
  • Mode 3: Workflow files
  • Other ways to run Pleb (Python API)
• Pleb Modes and Entry Points
  • Summary: modes and permutations
  • Mode-specific config examples
  • 1. Pipeline run (default)
  • 2. QC report mode
  • 3. Param scan mode
  • 4. Ingest mode
  • 5. FixDataset apply mode
  • Workflow permutations
• Ingest Mapping
  • Canonical output layout
  • Running ingest
  • JSON schema
  • Example mapping
  • How to populate the mapping
  • Strict mapping rules
• Command-Line Interface
  • Core usage
  • CLI overrides (1:1 with TOML)
  • Common options
  • Quality-control (QC) flags
  • Parameter scan
  • Param-check mode (fit-only scans)
  • QC report subcommand
  • Ingest subcommand
  • Workflow subcommand
  • Public-release compare subcommand
• Concepts
  • Timing residuals
  • Reduced chi-square
  • Dispersion measure (DM) variations
  • Red noise and correlated residuals
  • Backend offsets and jumps
  • Pulsar timing in context
• Examples
  • Compare two branches of a data set
  • Param-scan for DM derivatives
  • QC-assisted outlier review
• Flow Diagrams
  • Pipeline Mode
  • Ingest Mode
  • Param-Scan Mode
  • QC-Report Mode
  • Workflow Mode
  • PQC Usage 1: Detection Only
  • PQC Usage 2: Detect Then Apply QC Comments/Deletes
  • PQC Usage 3: Standalone QC Report on Existing QC CSVs
  • PQC Core Detection Sequence

Project Notes

• Release Notes
  • Since release/v0.1.0
• FAQ
  • What inputs does the pipeline expect?
  • Why are my residuals structured versus frequency?
  • What does a high reduced chi-square mean?
  • Does the pipeline model red noise directly?
  • How should I interpret backend-dependent offsets?
  • Where can I learn more about pulsar timing?
• GUI (Experimental)
  • What it provides
  • Install
  • Run
  • Notes

Reference

• API Reference
  • BinaryAnalysisConfig
  • FixDatasetConfig
  • IngestConfig
  • ParamScanConfig
  • PipelineConfig
  • QCReportConfig
  • WorkflowRunConfig
  • fix_pulsar_dataset()
  • run_param_scan()
  • run_pipeline()
  • write_binary_analysis()
  • write_fix_report()
• Internal Modules (No Index)
  • Notes
  • Worked example
  • References
  • See Also
  • Notes
  • Worked example
  • References
  • See Also
  • Notes
  • References
• References