Getting Started

PyCBC is a software package used to explore astrophysical sources of gravitational waves. It contains algorithms that can detect coalescing compact binaries and measure the astrophysical parameters of detected sources. PyCBC was used in the first direct detection of gravitational waves (GW150914) by LIGO and is used in the ongoing analysis of LIGO and Virgo data. If you use PyCBC in your scientific publications or projects, we ask that you acknowlege our work by citing the papers described on the page:

If you have Docker installed, you can get started using PyCBC with just two commands:

pycbc — bash — 80x25

For more details, including instructions on starting a container that can display graphics, see:

About PyCBC

The goals of the PyCBC project are:

  • Provide reliable and robust tools for building gravitational-wave search and parameter estimation workflows for CBCs.
  • Create a flexible, extensible production code for CBC analysis that can be released for the public.
  • Enable simple, easy and transparent access for various many-core architectures like GPUs.

Full installation instructions for users who want to install and develop PyCBC are available at:

Documentation for Users

Users who want to create and run scientific workflows to search for compact binaries should read the documentation in the links at:

Users who want to create and run parameter estimation workflows should read the documentation at:

Users who are interested in tools that PyCBC provides for various other analysis tasks (e.g. template bank generation, hardware injections, and testing template banks) should read the documentation at:

Users who are intersted in using PyCBC utilities and functions should take a look at the short code snippets below.

Documentation for Developers

Documentation on building stand-alone bundled executables with PyInstaller is available at:

PyCBC developers should read the pages below which explain how to write documentation, develop the code, and create releases:

Developers who are interested in file I/O, data storage, and access should read the documentation at:

Developers who are interested in creating new scientific workflow generation scripts should read the documentation at:

Full Module Documentation is avaialable at:

Indexes and Tables