bilby-lisa 1.0.0a2

Python package to extend the functionality of `bilby` to perform Bayesian inference with the LISA gravitational-wave detector

bilby_lisa

Description

Plug in for bilby to perform Bayesian inference with LISA. See this paper for details.

Citing

If you make use of this code, please cite the bilby_lisa paper

@article{Hoy:2023ndx,
    author = "Hoy, Charlie and Nuttall, Laura K.",
    title = "{BILBY in space: Bayesian inference for transient gravitational-wave signals observed with LISA}",
    eprint = "2312.13039",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    month = "12",
    year = "2023"
}

Installation instructions

We recommend installing bilby_lisa with mamba. To install bilby_lisa with mamba, simply run,

$ mamba create --name bilby-lisa python=3.10 -c conda-forge bilby_lisa

To install bilby_lisa with PyPI, an environment must first be created with certain required dependencies in order to compile bbhx. An environment can be created with,

$ mamba create --name bilby-lisa python=3.10 numpy schwimmbad gcc_linux-64 gxx_linux-64 gsl lapack=3.6.1 Cython

If on MACOSX, substitue gcc_linux-64 and gxx_linux-64 with clang_osx-64 and clangxx_osx-64. The latest stable release of bilby_lisa can then be installed with PyPI,

(bilby-lisa)$ python -m pip install bilby_lisa

If you wish to install from source, you can clone the git repository, navigate to the root source directory and run,

(bilby-lisa)$ python -m pip install .

Once bilby_lisa has been installed, non-released versions of bilby, bilby_pipe and parallel_bilby need to be installed. This is because we are waiting for required code to be merged into the main bilby, bilby_pipe and parallel_bilby code bases. Please see the following merge requests for details:

• bilby!1314
• bilby_pipe!583
• bilby_pipe!586
• parallel_bilby!137
• parallel_bilby!138

The required non-released versions of bilby, bilby_pipe and parallel_bilby can be installed with:

$ python -m pip install --force-reinstall "git+https://git.ligo.org/charlie.hoy/bilby.git@ifo_plugin" "git+https://git.ligo.org/charlie.hoy/bilby_pipe.git@input_plus_det_plugin" "git+https://git.ligo.org/charlie.hoy/parallel_bilby.git@input_plus_parser"

and the bbhx package can be installed with,

$ python -m pip install "git+https://github.com/mikekatz04/BBHx.git"

Alternatively, you can clone the git repository, navigate to the root source directory and run,

$ python -m pip install -r requirements.txt --force-reinstall

The non-released versions of bilby, bilby_pipe and parallel_bilby are rebased onto the following tags:

• bilby: v2.2.2
• bilby_pipe: v1.3.0
• parallel_bilby: v2.0.2