Welcome to astro_traj’s documentation!

Installing astro_traj

The easiest method to install astro_traj is using pip directly from the GitHub repository:

$ pip install git+https://github.com/astro-traj/astro-traj

How to run astro_traj

The main product of this package is the command-line executable LIGOtraj

To run an analysis, you need to specify a file that holds the posterior samples from your favorite PE run, an effective radius of your galaxy (in kpc), and an offset for the event (in kpc):

$ LIGOTraj --samples 'path_to_samples' --effective-radius 'float' --offset 'float'

You can specifty the number of trials and the name of your output file using flags. You can also alter the galaxy and telescope properties or add a new galaxy/telescope using dictionaries in the constr_dict.py file.

$ LIGOTraj --samples 'path_to_samples' --effective-radius 'float' --offset 'float' --galaxy 'NGC' --telescope 'ESO' --trails 100 --outfile 'path_to_output'

For a full list of command-line argument and options, run

$ LIGOTraj --help

For more details see Running LIGOTraj on the command line.

Package documentation

Please consult these pages for more details on using astro_traj:

Indices and tables