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
      • BaseSearchClass
      • ComputeFstat
      • SemiCoherentSearch
      • SearchForSignalWithJumps
      • SemiCoherentGlitchSearch
      • DeprecatedClass
      • DefunctClass
    • pyfstat.grid_based_searches module
      • GridSearch
      • TransientGridSearch
      • SliceGridSearch
      • GridUniformPriorSearch
      • GridGlitchSearch
      • SlidingWindow
      • FrequencySlidingWindow
      • EarthTest
      • DMoff_NO_SPIN
    • pyfstat.gridcorner module
      • log_mean()
      • max_slice()
      • idx_array_slice()
      • gridcorner()
      • projection_2D()
      • projection_1D()
    • pyfstat.injection_parameters module
      • custom_prior()
      • uniform_sky_declination()
      • InjectionParametersGenerator
      • AllSkyInjectionParametersGenerator
    • pyfstat.logging module
      • set_up_logger()
    • pyfstat.make_sfts module
      • Writer
      • BinaryModulatedWriter
      • LineWriter
      • GlitchWriter
      • FrequencyModulatedArtifactWriter
      • FrequencyAmplitudeModulatedArtifactWriter
    • pyfstat.mcmc_based_searches module
      • Defining the prior
      • MCMCSearch
      • MCMCGlitchSearch
      • MCMCSemiCoherentSearch
      • MCMCFollowUpSearch
      • MCMCTransientSearch
    • pyfstat.optimal_setup_functions module
      • get_optimal_setup()
      • get_Nstar_estimate()
    • pyfstat.snr module
      • SignalToNoiseRatio
      • DetectorStates
    • pyfstat.tcw_fstat_map_funcs module
      • pyTransientFstatMap
      • fstatmap_versions
      • init_transient_fstat_map_features()
      • call_compute_transient_fstat_map()
      • lalpulsar_compute_transient_fstat_map()
      • reshape_FstatAtomsVector()
      • pycuda_compute_transient_fstat_map()
      • pycuda_compute_transient_fstat_map_rect()
      • pycuda_compute_transient_fstat_map_exp()
    • 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