Running LIGOTraj on the command line

As described on the home page, the main interface to the wscan algorithm is the command-line executable LIGOTraj.

Basic instructions

Basic instructions on running LIGOTraj can be gained by looking at the --help menu:

$ LIGOTraj --help
usage: LIGOTraj [-h] [-V] -o OFFSET -r EFFECTIVE_RADIUS -s SAMPLES [-g GALAXY]
                [-t TELESCOPE] [-T TRIALS] [-f OUTFILE] [--Apre APRE]
                [--Mhe MHE] [--Vkick VKICK] [--Ms MS] [--epre EPRE]
                [--distance DISTANCE] [--sys-flag SYS_FLAG]

Main function. Samples parameters, implements kicks, and sees whether the
systems is a 'successful' merger by merging at the proper projected distance.
Writes to csv file in following format: [M2, Mns, Mhe, Apre, Apost, epre,
epost, R, galcosth, galphi, Vkick, Tmerge, Rmerge, Rmerge_proj, Vfinal, flag]
Flag description: 0: Binary doesn't merge at the proper projected distance 1:
Binary mergers at the correct projected distance 2: Binary's inspiral time is
greater than 10 Gyr, does not evolve 3: Binary is disrupted by SN kick 4:
Energy conservation requirement not met!!!

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -o OFFSET, --offset OFFSET
                        Offset from center of galaxy of event
  -r EFFECTIVE_RADIUS, --effective-radius EFFECTIVE_RADIUS
                        Effective radius
  -s SAMPLES, --samples SAMPLES
                        Path to posterior samples
  -g GALAXY, --galaxy GALAXY
                        Name of galaxy that is pulled from the dictionaries in
                        constr_dict.py. Default=NGC
  -t TELESCOPE, --telescope TELESCOPE
                        Name of telescope that is pulled from the dictionaries
                        in constr_dict.py. Default=ESO
  -T TRIALS, --trials TRIALS
                        Specify the number of trials. Default=1
  -f OUTFILE, --outfile OUTFILE
                        Name of the output file. Default=output
  --Apre APRE           Specify sampling procedure for initial semi-major
                        axis. Default=uniform
  --Mhe MHE             Specify sampling procedure for helium star mass.
                        Default=uniform
  --Vkick VKICK         Specify sampling procedure for kick velocity.
                        Default=maxwellian
  --Ms MS               Specify sampling procedure for NS masses.
                        Default=posterior
  --epre EPRE           Specify sampling procedure for initial eccentricity.
                        Default=circularized
  --distance DISTANCE   Specify sampling procedure for the distance.
                        Default=median
  --sys-flag SYS_FLAG   Specify a flag for testing aspects of the orbital
                        evolution. Current options: 'circ_test' for setting
                        the kick velocity to 0 and checking that the galactic
                        orbits are circular; 'vkick_test' for setting the
                        galactic orbital velocity to 0 and seeing the affect
                        of just the SN kick. Default=delta_function

Detailed instructions

A few of the command-line options require special formatting, use the reference below for more detailed info.