options_example.ini

This is an example config file for the various FIGARO command line scripts. Model your ini file after this one (please remember the [DEFAULT] section).
You're not required to provide all the various options: the only required ones are input and bounds.All the others, if not provided, will fall back to default values. Options that are not listed here will be ignored, but no warning message will be displayed.
Any command-line option will override the corresponding one provided in the config file.

[DEFAULT]
input             = /path/to/samples.txt or folder/with/samples [probability density samples file (density estimation) or folder (hierarchical inference)]
bounds            = [[xmin,xmax],[ymin,ymax],...]               [bounds of the reconstruction]
output            = path/to/output/folder                       [output folder]
ext               = pkl                                         [extension of the mixture output file: 'pkl' or 'json']
inj_density_file  = /path/to/injected_density.py                [must contain density() method]
selfunc_file      = path/to/selection_function.py               [must contain selection_function() method]
par               = None                                        [GW parameter as in LVK data release, ignored for .txt, .csv and .dat]
wf                = combined                                    [waveform model family: 'combined', 'imr', 'seob']
postprocess       = False                                       [postprocess the data]
symbol            = \\mathrm{X}_1,\\mathrm{Y}_2                 [LaTeX-style variable symbols without $$]
unit              = m/s^{-1},\\mathrm{Mpc}                      [LaTeX-style variable units without $$]
draws             = 100                                         [number of realisations to draw]
se_draws          = 100                                         [number of realisations to draw for single events (hierarchical only)]
n_samples_dsp     = -1                                          [downsampling. Omit or set to -1 to use all samples]
exclude_points    = False                                       [exclude points outside bounds, for probit transformation]
cosmology         = h,om,ol                                     [cosmological parameters. Defaults from Planck 2018]
sigma_prior       = None                                        [prior expectation for standard deviation. Either one value in total or one value per parameter]
se_sigma_prior    = None                                        [prior expectation for single event standard deviation as above (hierarchical only)]
fraction          = None                                        [fraction of samples standard deviation to use as prior expectation]
probit            = True                                        [whether to use the probit transformation or not]
MC_draws          = 1000                                        [number of samples for MC integral (hierarchical only)]
save_single_event = False                                       [whether to save single event density plot (hierarchical only)]
hier_name         = None                                        [name to be given to hierarchical inference file (hierarchical only)]
run_events        = True                                        [whether to run the single event analysis (hierarchical only)]
n_parallel        = 2                                           [number of parallel instances to run (parallelised only)]