|
|
# PyFstat
|
|
|
|
|
|
This is a python package providing an interface to perform F-statistic based
|
|
|
continuous gravitational wave (CW) searches. At its core, this is a simple
|
|
|
wrapper of selected tools in
|
|
|
This the wiki for a PyFstat, a python package providing an interface to perform
|
|
|
F-statistic based continuous gravitational wave (CW) searches. At its core,
|
|
|
this is a simple wrapper of selected tools in
|
|
|
['lalpulsar'](http://software.ligo.org/docs/lalsuite/lalpulsar/). The general
|
|
|
idea is to allow easy scripting of new search pipelines, we focus
|
|
|
primarily on interfacing the CW routines with
|
|
|
[emcee](http://dan.iel.fm/emcee/current/) a python MCMC sampler.
|
|
|
idea is to allow easy scripting of new search pipelines, we focus primarily on
|
|
|
interfacing the CW routines with [emcee](http://dan.iel.fm/emcee/current/) a
|
|
|
python MCMC sampler.
|
|
|
|
|
|
## Glitch-robust search
|
|
|
|
|
|
The primary use case of this software is the *semi-coherent glitch-robust*
|
|
|
search. You may find a help page explaining how to use this [here](docs/glitch-robust-search).
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
We include a variety of example search scripts [here](examples), for each
|
|
|
We include a variety of example search scripts [here](https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat/tree/master/examples), for each
|
|
|
example there is also a more descriptive write-up containing examples of the
|
|
|
output which we list below. Before running any of the search examples, be sure
|
|
|
to have run the [script to generate fake data](examples/make_fake_data.py).
|
|
|
to have run the [script to generate fake data](docs/make-fake-data).
|
|
|
|
|
|
* [Making fake data with and without glitches](docs/make_fake_data.md)
|
|
|
* [Fully-coherent MCMC search](docs/fully_coherent_search_using_MCMC.md)
|
|
|
* [Fully-coherent MCMC search on data containing a single glitch](docs/fully_coherent_search_using_MCMC_on_glitching_data.md)
|
|
|
* [Semi-coherent MCMC glitch-search on data containing a single glitch](docs/semi_coherent_glitch_search_using_MCMC_on_glitching_data.md)
|
|
|
* [Semi-coherent MCMC glitch-search on data containing two glitches](docs/semi_coherent_glitch_search_with_two_glitches_using_MCMC_on_glitching_data.md)
|
|
|
* [Semi-coherent Follow-Up MCMC search (dynamically changing the coherence time)](docs/follow_up.md) |
|
|
* [Making fake data with and without glitches](docs/make-fake-data)
|
|
|
* [Fully-coherent MCMC search](docs/fully-coherent-search-using-MCMC)
|
|
|
* [Fully-coherent MCMC search on data containing a single glitch](docs/fully-coherent-search-using-MCMC-on-glitching-data)
|
|
|
* [Semi-coherent MCMC glitch-search on data containing a single glitch](docs/semi-coherent-glitch-search-using-MCMC-on-glitching-data)
|
|
|
* [Semi-coherent MCMC glitch-search on data containing two glitches](docs/semi-coherent-glitch-search-with-two-glitches-using-MCMC-on-glitching-data)
|
|
|
* [Semi-coherent Follow-Up MCMC search (dynamically changing the coherence time)](docs/follow-up) |