bilby_pipe_review

Command line interface for running standard review tests

Tools for running the bilby review

Select from the options below to create an ini file which can be submitted using bilby_pipe. Alternatively, use the --submit option to also submit the job.

Note

These were the primary review tests performed until LIGO-Virgo-KAGRA’s third observing run.

More recent review tests used this data.

usage: bilby_pipe_review [-h] [--submit] [--build] [--directory DIRECTORY]
                         (--bbh | --bns | --pp-test | --create-dir) [--roq]
                         [--roq-folder ROQ_FOLDER] [--zero-noise]
                         [--prior {128s,128s_tidal,128s_tidal_lowspin,16s,32s,4s,64s,8s,high_mass}]
                         [--duration {4,8,16,32,64,128}] [--sampler SAMPLER]
                         [--marginalization MARGINALIZATION [MARGINALIZATION ...]]
                         [--detectors DETECTORS [DETECTORS ...]]
                         [--nlive NLIVE] [--nact NACT] [--maxmcmc MAXMCMC]
                         [--walks WALKS] [--n-parallel N_PARALLEL]
                         [--reference-frequency REFERENCE_FREQUENCY]
                         [--generation-seed GENERATION_SEED]

Named Arguments

--submit

Build and submit the job

Default: False

--build

Build the job

Default: False

--directory

Set the top-level directory to use, defaults to a standardise naming scheme

--bbh

Fiducial BBH test

Default: False

--bns

Fiducial BNS test

Default: False

--pp-test

PP test test

Default: False

--create-dir

Create test directory and exit

Default: False

--roq

Use ROQ likelihood

Default: False

--roq-folder

The ROQ folder to use, defaults to IMRPhenomPv2

--zero-noise

Run BBH and BNS test with zero noise

Default: False

--prior

Possible choices: 128s, 128s_tidal, 128s_tidal_lowspin, 16s, 32s, 4s, 64s, 8s, high_mass

The default prior to use

--duration

Possible choices: 4, 8, 16, 32, 64, 128

Signal duration

--sampler

Sampler to use, default is dynesty

Default: 'dynesty'

--marginalization

A space-separated list of {time, distance, phase} marginalizationchoices, default –marginalization time distance phase

Default: ['time', 'distance', 'phase']

--detectors

The detectors to use for simulating data, default [H1, L1]

Default: ['H1', 'L1']

--nlive

The number of live points to use, default None (use bilby defaults)

--nact

The nact (for dynesty only) to use, default None (use bilby defaults)

--maxmcmc

The maxmcmc to use, default None (use bilby defaults)

--walks

The walks (minimum mcmc) to use, default None (use bilby defaults)

--n-parallel

The number of parallel-processes to use, default 4

Default: 4

--reference-frequency

The reference frequency to run tests at, default 20

Default: 20

--generation-seed

The seed used for generation: reproducible injections, default 1010

Default: 1010