Welcome to xpipeline’s documentation!¶
X Pipeline is a burst gravitational-wave search algorithm. It can perform SN, GRB, and ALLSKY searches. For full details see Sutton et al. (IOP, 2010) and Was et al. (PRD, 2012)
Installing xpipeline¶
The easiest method to install xpipeline is using pip directly from the GitHub repository:
$ pip install git+https://github.com/X-Pypeline/X-Pypeline.git
How to run xpipeline¶
The main product of this package is the command-line executable xpipeline-workflow, which runs a script that sets up X-Pipeline gravitational-wave searches of SN GRB and ALLSKY/SPHRAD.
To run an analysis:
$ xpipeline-workflow -p grb_full.ini --grb-name GRB160830 -g 1156610000 -r 307.65 -d 45.72 -i H1 L1 V1 -s grb --FAP=99.9
where -g is the GPS time of the GRB event, and -p grb_full.ini is the path of your configuration file.
For a full list of command-line argument and options, run
$ xpipeline-workflow --help
For more details see Running xpipeline-workflow on the command line.
Package documentation¶
Please consult these pages for more details on using xpipeline: