README.md 2.13 KB
Newer Older
1
2
3
# PyFstat

This is a python package containing basic wrappers of the `lalpulsar` module
4
with capabilities to perform a variety of searches, primarily focusing on
5
6
semi-coherent glitch searches.

7
8
## Examples

9
10
11
12
We include a variety of example search scripts [here](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).
13
14

* [Making fake data with and without glitches](docs/make_fake_data.md)
15
16
* [Fully coherent MCMC search](docs/fully_coherent_search_using_MCMC).md)
* [Fully coherent MCMC search on data containing glitching signals](docs/fully_coherent_search_using_MCMC_on_glitching_data.md)
17

18
19
20
21
## Installation

The script can be installed system wide via
```
22
$ python setup.py install
23
```
24
25
26
27
28
29
or simply add this directory to your python path. To check that the installation
was successful, run
```
$ python -c 'import pyfstat'
```
if no error message is output, then you have installed `pyfstat`.
30
31
32
33

### Ephemeris installation

The scripts require a path to ephemeris files in order to use the
34
35
`lalpulsar.ComputeFstat` module. This can either be specified when initialising
each search, or more simply by placing a file `~/pyfstat.conf` into your home
36
37
38
39
40
41
directory which looks like

```
earth_ephem = '/home/<USER>/lalsuite-install/share/lalpulsar/earth00-19-DE421.dat.gz'
sun_ephem = '/home/<USER>/lalsuite-install/share/lalpulsar/sun00-19-DE421.dat.gz'
```
42
here, we use the default ephemeris files provided with `lalsuite`.
43
44
45
46
47
48

### Dependencies

* swig-enabled lalpulsar, a minimal configuration is given by

```
49
$ ./configure --prefix=${HOME}/lalsuite-install --disable-all-lal --enable-lalpulsar --enable-lalapps --enable-swig
50
51
52
53
54
```

* [emcee](http://dan.iel.fm/emcee/current/)[^1]
* [corner](https://pypi.python.org/pypi/corner/)[^1]
* [dill](https://pypi.python.org/pypi/dill)[^1]
55
56
* [tqdm](https://pypi.python.org/pypi/tqdm)[^1] (optional), if installed, this
  provides a useful progress bar and estimate of the remaining run-time.
57

58
[^1]: Most easily installed using either `conda` or `pip`.
59