PQC Documentation

Contents:

• Overview
  • Core capabilities
  • Why a QC layer?
  • PTA context
  • References
• Installation
  • Editable install (development)
  • Standard install from a local checkout
  • Dependencies and environment
• Quickstart
  • Before you start
  • How this actually loads data
  • CLI (fastest path)
  • Python (notebook-friendly)
  • Inspect results
  • What you get
  • Important semantics
  • Minimal statistical context
  • References
• Concepts
  • Backends and grouping
  • Residuals and noise
  • Bad measurement detection
  • Transient events
  • Global astrophysical events
  • Step and DM-step events
  • Membership semantics
  • Covariate-conditioned preprocessing
  • References
• Statistical Tests
  • OU Innovations
  • Benjamini-Hochberg FDR
  • MAD-Based Robust Scores
  • Delta-Chi2 Model Comparison
  • Detector-to-Statistic Mapping
• Command line
  • Basic run
  • Custom thresholds
  • Exponential dips
  • Logging
  • Statistical knobs (what they mean)
  • Feature structure and grouping
  • Preprocessing for selected detectors
  • Settings output
  • References
• Examples
  • Tutorial: end-to-end QC in 5 minutes
  • Configured pipeline
  • Feature structure diagnostics
  • Step and DM-step interpretation
  • Plotting event membership
  • Solar elongation diagnostic
  • Preprocessing before detectors
  • Hard sigma gate
  • Exponential dip events
  • Solar and eclipse events
  • Gaussian-bumps and glitches
  • References
• FAQ
  • Why do I only see API reference pages?
  • How can PQC load residuals when I only pass a .par file?
  • How do I plot event membership?
  • What does FDR mean here?
  • References
• API Reference
  • pqc
  • pqc.cli
  • pqc.config
  • pqc.pipeline
  • pqc.detect
  • pqc.detect.bad_measurements
  • pqc.detect.ou
  • pqc.detect.transients
  • pqc.features
  • pqc.features.backend_keys
  • pqc.io
  • pqc.io.libstempo_loader
  • pqc.io.merge
  • pqc.io.timfile
  • pqc.utils
  • pqc.utils.diagnostics
  • pqc.utils.logging
  • pqc.utils.stats