# FLITS

> Interactive and scriptable fast radio burst (FRB) analysis software

FLITS (Fast-Look Interactive Transient Suite) measures fast radio bursts
(FRBs) in dynamic spectra: SIGPROC filterbank (.fil), PSRFITS (.fits,
.sf) and CHIME/FRB HDF5 (.h5) files. It masks interference, localizes
the burst in time and frequency, optimizes the DM, and measures S/N,
peak flux, fluence, widths, arrival times, sub-burst drift rate and
rotation measure, with each uncertainty classified. It starts from a
burst you already have; it is not a search pipeline.

Install with `pip install flits` (Python 3.11+). Three ways to use it:

- `flits measure FILE... --dm DM` measures bursts without a browser and
  prints JSON (or `--format jsonl|csv`). Pin choices with `--event`,
  `--offpulse`, `--band` or `--crop`. Save sessions with
  `--snapshot-dir`. Exit code 0 means every burst was measured.
- Python: `flits.BurstSession.from_file(path, dm=...)`, then
  `auto_mask()`, `auto_localize()` and `compute_properties()`;
  or `flits.measure_burst(path, flits.MeasureOptions(dm=...))`.
- `flits --data-dir DIR` serves the browser interface; `flits demo`
  opens a prepared example burst.

Sessions are saved as JSON snapshots; `flits replay SNAPSHOT --check`
recomputes their measurements from the original data.


## Getting started

- [Quickstart](https://dirkkuiper.github.io/flits/getting-started/index.md): Install FLITS, try the demo, and load a burst
- [Guided Workflow](https://dirkkuiper.github.io/flits/guided-workflow/index.md): A complete worked example on a public GBT burst, with reference values
- [PSRFITS and CHIME Examples](https://dirkkuiper.github.io/flits/format-workflows/index.md): Generate synthetic PSRFITS and CHIME inputs, measure and replay them
- [Scientific Validation](https://dirkkuiper.github.io/flits/validation/index.md): Independent comparisons, injected signals, numerical tolerances and tested limits
- [Installation and Deployment](https://dirkkuiper.github.io/flits/installation/index.md): Python, Docker, Apptainer, and remote or HPC deployment

## Scripting

- [Inspection and Runtime](https://dirkkuiper.github.io/flits/user-guide/inspection/index.md): Inspect file metadata and verify local and server runtime identities
- [Headless Measurement](https://dirkkuiper.github.io/flits/user-guide/headless-measurement/index.md): Measure bursts from the command line or Python, in batches
- [Batch Manifests and Schemas](https://dirkkuiper.github.io/flits/user-guide/automation-contracts/index.md): Per-burst JSON manifests and versioned offline output schemas
- [Headless Replay](https://dirkkuiper.github.io/flits/user-guide/headless-replay/index.md): Recompute and check a saved session without a browser
- [Coding Agents](https://dirkkuiper.github.io/flits/user-guide/coding-agents/index.md): Have coding agents use FLITS, with the FLITS skill
- [Python API](https://dirkkuiper.github.io/flits/developer/api-reference/index.md): The Python API, BurstSession first

## User guide

- [Session Workflow](https://dirkkuiper.github.io/flits/user-guide/session-workflow/index.md): Working through a session in the interface
- [Exports and Snapshots](https://dirkkuiper.github.io/flits/user-guide/exports-and-snapshots/index.md): Export bundles, session snapshots, and provenance
- [Uncertainties](https://dirkkuiper.github.io/flits/user-guide/uncertainties/index.md): What each kind of uncertainty is and how to add missing terms
- [Supported Formats](https://dirkkuiper.github.io/flits/user-guide/supported-formats/index.md): Supported file formats and telescope presets

## Analysis methods

- [DM Optimization](https://dirkkuiper.github.io/flits/analysis/dm-optimization/index.md)
- [Sub-Burst Drift](https://dirkkuiper.github.io/flits/analysis/drift/index.md)
- [Burst Localization](https://dirkkuiper.github.io/flits/analysis/localization/index.md)
- [Measurements](https://dirkkuiper.github.io/flits/analysis/measurements/index.md)
- [Model Fitting](https://dirkkuiper.github.io/flits/analysis/model-fitting/index.md)
- [Rotation-Measure Synthesis](https://dirkkuiper.github.io/flits/analysis/rm-synthesis/index.md)
- [Multiscale Temporal Power](https://dirkkuiper.github.io/flits/analysis/temporal-multiscale/index.md)
- [Temporal and Spectral Analysis](https://dirkkuiper.github.io/flits/analysis/temporal-spectral/index.md)