Skip to main content

Browser-based FRB burst analysis software (SIGPROC, PSRFITS, CHIME/FRB HDF5)

Project description

FLITS

Docs PyPI Python Tests Install License: GPLv3

Fast-Look Interactive Transient Suite.

FLITS is browser-based FRB analysis software for interactive burst inspection, masking, measurement, DM optimization, temporal/spectral diagnostics, and export. It reads SIGPROC filterbank (.fil), PSRFITS search/fold data (.fits, .sf), and CHIME/FRB HDF5 (.h5, .hdf5) including public catalog waterfalls and beamformed BBData tiedbeam_power files. The I/O layer is pluggable — third parties can register custom formats via importlib entry points without forking.

Quick Start

Install the published package:

pip install flits
flits --data-dir /path/to/filterbanks --host 127.0.0.1 --port 8123

Then open http://127.0.0.1:8123.

Optional model fitting uses fitburst, which is intentionally left out of the PyPI dependency metadata because package indexes reject direct URL runtime dependencies. To enable model fitting after installing FLITS:

pip install "fitburst @ https://github.com/CHIMEFRB/fitburst/archive/3c76da8f9e3ec7bc21951ce1b4a26a0255096b69.tar.gz"

Highlights

  • Browser-based workflow for burst inspection on SIGPROC, PSRFITS, and CHIME/FRB HDF5 data.
  • CHIME support includes public catalog waterfalls and beamformed BBData power products.
  • Interactive crop, event, off-pulse, spectral-window, and masking controls.
  • Automatic burst localization in time and frequency (matched-filter event window, spectral extent, and off-pulse placement in one click).
  • Calibrated fluence and peak-flux outputs when an SEFD is available.
  • DM optimization using integrated-event S/N and DMphase.
  • Temporal-structure, PSD, ACF, and optional selected-event model fitting.
  • Weighted Q/U RM synthesis with optional RM-CLEAN, significance and quality diagnostics, and JSON/CSV products.
  • Export bundles and JSON session snapshots for reproducible analysis.

Documentation

The docs cover Python installs, Docker, Apptainer, remote/HPC use, interactive workflow guidance, measurements, DM optimization, temporal/spectral analysis, exports, and release procedures.

Release Channels

  • PyPI and ghcr.io/dirkkuiper/flits:latest track stable releases.
  • ghcr.io/dirkkuiper/flits:<version> pins an exact release.
  • ghcr.io/dirkkuiper/flits:edge tracks the current main branch for snapshot testing.

Citation

If you use FLITS in research, cite the software and link to the repository:

  • PyPI package: flits
  • Repository: https://github.com/DirkKuiper/flits
  • Citation metadata: CITATION.cff

License

FLITS is released under the GNU GPLv3. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flits-0.8.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flits-0.8.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file flits-0.8.0.tar.gz.

File metadata

  • Download URL: flits-0.8.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flits-0.8.0.tar.gz
Algorithm Hash digest
SHA256 602b65661e308e1e302f26e59d77bdc3987fea5ed94c5a2b616116652b851733
MD5 b607f50a9d7c1b1d111a6b0cf9e6ed98
BLAKE2b-256 09bfa3924ab45e860a0cf44cd5f3ffc39336b0caec3fff3c040fd117a19e1f66

See more details on using hashes here.

Provenance

The following attestation bundles were made for flits-0.8.0.tar.gz:

Publisher: release.yml on DirkKuiper/flits

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flits-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: flits-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flits-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae0adee8dcf023b206de65a4f9c658360e57cfbd47492013e5c7e80493a650dd
MD5 d7f703596cc6f8ff9f2be4770eb492de
BLAKE2b-256 663e11376f2eccc20fdd8e1fe99b7bb351d310523854379915f358cb00b5a4b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for flits-0.8.0-py3-none-any.whl:

Publisher: release.yml on DirkKuiper/flits

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page