Welcome to PyFstat’s documentation!

This is a python package providing an interface to perform F-statistic based searches for continuous gravitational waves (CWs), built on top of the LALSuite library.

The source repository and issue tracker for PyFstat can be found at github.com/PyFstat/PyFstat.

Contents:

• PyFstat
  • Installation
    • pip install from PyPI
    • conda installation
    • Docker container
    • pip install from github
    • install PyFstat from source (Zenodo or git clone)
    • Dependencies
    • Optional dependencies
    • Using LALSuite built from source
  • Contributing to PyFstat
  • Contributors
  • Citing this work
• PyFstat module documentation
  • pyfstat package
    • Subpackages
      • pyfstat.utils package
    • Submodules
    • pyfstat.core module
    • pyfstat.grid_based_searches module
    • pyfstat.gridcorner module
    • pyfstat.injection_parameters module
    • pyfstat.logging module
    • pyfstat.make_sfts module
    • pyfstat.mcmc_based_searches module
      • Defining the prior
    • pyfstat.optimal_setup_functions module
    • pyfstat.snr module
    • pyfstat.tcw_fstat_map_funcs module
    • Module contents
• Examples
  • Grid searches for isolated CW
  • MCMC searches for isolated CW signals
  • Comparison between MCMC and Grid searches
  • Multi-stage MCMC follow up
  • Binary-modulated CW searches
  • Glitch robust CW searches
  • Transient CW searches
  • Other examples

Indices and tables

• Index

• Module Index

• Search Page