binado / standard-sirens

A repository with pedagogical content on gravitational-wave standard sirens.

sirenslib

This repository hosts utility methods for projects working with gravitational-wave standard sirens.

Installation

From source

Clone the repository to your local machine with

git clone https://github.com/binado/standard-sirens.git

Run

pip install .

You may also use flags for installing optional dependencies. Use

pip install .[gwdali]

to install gwdali, which is used as a benchmark in the fast_injections notebook.

The pseudo-$C_{\ell}$ computation is performed with the naMaster package. You may install it with the command

pip install numpy && pip install .[pymaster]

See this discussion for why manually installing numpy first is required. If this approach throws errors, a simpler alternative may be to install it via the conda-forge recipe (not sure if it is up-to-date).

conda create -n [myenv] python=3.10 && conda activate [myenv]
python -m pip install .
conda install -c conda-forge namaster

Notebooks

There are several Jupyter notebooks available in the notebooks directory highlighting use cases for the code.

Running scripts

Scripts are stored in the sirenslib/scripts directory, and are automatically installed. Click here for a complete list and usage instractions.