CWInPy documentation#

CWInPy is a Python package designed to perform searches for, and inference on, continuous quasi-monochromatic gravitational-wave signals. In particular, signals that might be emitted by non-axisymmetric and rapidly rotating neutron stars, such as pulsars. CWInPy stands for “Continuous (gravitational) Wave Inference in Python”.

The package provides tools for processing raw gravitational-wave strain time-series data based on the phase evolution of a given source (using a Tempo-style parameter file); a class to store and display this data is available. Following data processing, the package provides tools for inferring the unknown gravitational-wave parameters describing the source and its orientation. An integrated pipeline combining both these stages (cwinpy_knope) is also provided. These tools are all available through command line executables and through a Python API. The pipelines can generate HTCondor DAGs to run analyses over long observing runs for multiple detectors and multiple sources on a computer cluster or via the Open Science Grid. The pipelines can be used on both open data (as hosted by the Gravitational-wave Open Science Center) and proprietary data from the LIGO and Virgo detectors.

In addition to these main functions, CWInPy enables users to:

Contributing#

CWInPy is open source and anyone is welcome to contribute. The development repository of CWInPy is publicly available at git.ligo.org/cwinpy/cwinpy and is mirrored on Github. Issues, discussions or pull requests can be opened in that Github repository, or can be emailed directly to contact+cwinpy-cwinpy-3315-issue-@support.ligo.org.

Code of conduct#

Contributors to CWInPy and users of any of the discussion forums are expected to treat each other with respect and abide by the guidelines of the Python Community Code of Conduct.