Configuration¶

General¶

output_parent_directory¶

Type:: string

The parent directory in which to create the output directory.

submit_only_at_exact_signal_position¶

Type:: integer
Default:: 0

If set to 1, submits a single ILE job at the event parameters, and performs no AMR. If set to 0, performs full AMR.

web_dir¶

Type:: string
Default:: N/A

The public_html directory in which the summary page will be created.

gracedb_url¶

Type:: string
Default:: https://gracedb.ligo.org/api/

URI for the GraceDB API used to interact with events. Should include the /api/ portion of the URI.

use_skymap¶

Type:: integer

Uses an existing skymap file if set to 1, or not if set to 0.

If set to 1, you must specify the file in skymap_file

use_event_spin¶

Type:: boolean

Uses trigger $\chi_z$ values file if set to True, or assumes zero spin if set to False.

cProfile¶

Type:: boolean
Default:: False

If True, each ILE job will be time profiled.

event_parameters_in_config_file¶

Type:: boolean

Warning

Currently values other than 0 are unsupported.

If set to 0, event parameters are taken from GraceDB. If set to 1, event parameters will be taken from the Event section.

n_iterations_per_job¶

Type:: integer

The number of iterations to perform. 1 would only compute the initial grid, 2 would refine once with AMR, etc.

seed¶

Type:: integer

Seed for random state object used in intrinsic posterior sampling.

accounting_group¶

Type:: string

The accounting group to use on Condor. Options can be found here.

accounting_group_user¶

Type:: string
Default:: the username used to run the program

The accounting group username to use on Condor.

getenv¶

Type:: list
Default:: [True]

Names of environment variable that HTCondor should copy from the submitter’s environment. Also accepts True or * to copy all environment variables.

Recommended variables:

DEFAULT_SEGMENT_SERVER
GWDATAFIND_SERVER
LAL_DATA_PATH
LD_LIBRARY_PATH
LIBRARY_PATH
NDSSERVER
PATH
PYTHONPATH

Warning

The current default value of [True] is included to keep backwards compatibility for the time being. Soon this will be dropped in favor of an empty list.

environment¶

Type:: dictionary
Default:: {}

Dictionary mapping environment variables to values, to be passed to HTCondor jobs.

Recommended values:

RIFT_LOWLATENCY: True

overwrite_existing_event_dag¶

Type:: integer
Default:: 0

If set to 1, overwrites an existing output directory, useful for testing.

submit_dag¶

Type:: integer

Auto-submits the generated DAG if set to 1. Only generates the DAG if set to 0.

email_address_for_job_complete_notice¶

Type:: string
Default:: N/A

If set, sends an email to the specified address once all jobs and plotting scripts have completed.

intrinsic_param_to_search¶

Type:: list of strings
Default:: [mass1,mass2]

A list of the intrinsic parameters to search over. Choices are:

[mass1,mass2]
[mass2,mass2,spin1z,spin2z]

If set to [mass1,mass2], the intrinsic grid will be 2D and rectilinear in two mass parameters. If set to [mass1,mass2,spin1z,spin2z], the intrinsic grid will be 4D and rectilinear in two mass and two spin parameters. However, the actual mass and spin parameters will depend on distance_coordinates

exe_integration_extrinsic_likelihood¶

Type:: string
Default:: rapidpe_integrate_extrinsic_likelihood

Executable to use for the integrate-extrinsic-likelihood / ILE step.

Can either be a path to the executable or just the name if available in your system’s $PATH. Names will be expanded while generating the DAG, rather than by Condor.

exe_generate_initial_grid¶

Type:: string
Default:: N/A

Executable to create the intrinsic grid. If not specified exe_grid_refine is used for initial grid.

Can either be a path to the executable or just the name if available in your system’s $PATH. Names will be expanded while generating the DAG, rather than by Condor.

exe_grid_refine¶

Type:: string
Default:: rapidpe_compute_intrinsic_grid

Executable which performs AMR.

Can either be a path to the executable or just the name if available in your system’s $PATH. Names will be expanded while generating the DAG, rather than by Condor.

exe_create_event_dag¶

Type:: string
Default:: rapidpe_create_event_dag

Executable which sets up the dag to run the ILE integration for every intrinsic grid point. It is run once per iteration.

Can either be a path to the executable or just the name if available in your system’s $PATH. Names will be expanded while generating the DAG, rather than by Condor.

Event¶

There are several different modes one can specify an event with. Each one is listed as a different sub-section in this document, but in an actual config file they are all part of the Event section.

gid¶

This mode specifies an event on GraceDB using its GraceDB ID

gracedb_id¶

Type:: string

The event’s GraceDB ID.

run_mode¶

Type:: string
Default:: online

The mode we’re running in, for the purpose of choosing channel names. Choices are:

online
o3replay
o2replay
gracedb

Note

Unlike the others, gracedb will look up the channel names from GraceDB.

query_shm¶

Type:: boolean
Default:: False

When enabled, frame files are first looked for in the high-speed, low-latency Shared Memory cache available on some LDAS resources under /dev/shm/kafka.

When disabled, or if it fails to find the frames, GWPy is used to look for the data locally with GWDataFind, and then remotely with NDS. For more details, see GWPy TimeSeries.get docs.

mdc_event_injection_file¶

Type:: string
Default:: N/A

Specify path to the injection XML file if the event is part of an MDC.

mdc_time_offset¶

Type:: string
Default:: N/A

If mdc_event_injection_file is specified, specify the time offset of the MDC from the injection file.

frame_data_types¶

Type:: dictionary
Default:: {"H1" : "H1_HOFT_C00", "L1" : "L1_HOFT_C00", "V1" : "V1Online"}

Specify the frame type of the data for each detector.

sid¶

This mode specifies an event on GraceDB using its superevent ID to fetch the corresponding preferred event.

superevent_id¶

Type:: string

The superevent’s ID. The corresponding preferred event will be used.

run_mode¶

Type:: string
Default:: online

The mode we’re running in, for the purpose of choosing channel names. Choices are:

online
o3replay
o2replay
gracedb

Note

Unlike the others, gracedb will look up the channel names from GraceDB.

query_shm¶

Type:: boolean
Default:: False

When enabled, frame files are first looked for in the high-speed, low-latency Shared Memory cache available on some LDAS resources under /dev/shm/kafka.

When disabled, or if it fails to find the frames, GWPy is used to look for the data locally with GWDataFind, and then remotely with NDS. For more details, see GWPy TimeSeries.get docs.

mdc_event_injection_file¶

Type:: string
Default:: N/A

Specify path to the injection XML file if the event is part of an MDC.

mdc_time_offset¶

Type:: string
Default:: N/A

If mdc_event_injection_file is specified, specify the time offset of the MDC from the injection file.

frame_data_types¶

Type:: dictionary
Default:: {"H1" : "H1_HOFT_C00", "L1" : "L1_HOFT_C00", "V1" : "V1Online"}

Specify the frame type of the data for each detector.

injections¶

This mode specifies a list of injections and the data to run RapidPE.

injections_file¶

Type:: string
Default:: /home/caitlin.rose/my_rapidPE_work/f2y2016data/subset_f2y2016inj/exact_inj/f2y2016_HLV_100shuffled_exactmasses.txt

List of injections. The columns in this file should include:

mass1
mass2
spin1z
spin2z
latitude
longitude
distance
psi0
phi0
inclination
geocent_end_time
original_index

cache_file¶

Type:: string
Default:: /home/caitlin.rose/my_rapidPE_work/f2y2016data/create_2016_L1H1_data/2016injecteddata/injected_frames.cache

Cache file containing path to the data.

psd_file¶

Type:: special list
Default:: [“H1=/home/caitlin.rose/my_rapidPE_work/f2y2016data/create_2016_L1H1_data/firstattempt/H1_psd_mid.xml.gz”, “L1=/home/caitlin.rose/my_rapidPE_work/f2y2016data/create_2016_L1H1_data/firstattempt/L1_psd_mid.xml.gz”, “V1=/home/caitlin.rose/my_rapidPE_work/f2y2016data/check_virgo_psd/V1_psd.xml.gz”]

Path to psd files for each detector.

skymap_file¶

Type:: string
Default:: /home/vinaya.valsan/rapidPE/sinead_rapidPE/pp-plots-from-scratch/skymap/2016_fits/$INJINDEX$/bayestar.fits.gz

Path to the Bayestar skymap file. If specified, these skymaps will be used as a prior for ILE.

channel_name¶

Type:: special list
Default:: ["H1=INJ_GAUSSIAN","L1=INJ_GAUSSIAN","V1=INJ_GAUSSIAN"]

Data channel name.

frame_data_types¶

Type:: dictionary
Default:: {"H1" : "H1_HOFT_C00", "L1" : "L1_HOFT_C00", "V1" : "V1Online"}

Specify the frame type of the data for each detector.

InitialGridOnly¶

This section is passed verbatim to the executable specified in exe_grid_refine.

total-points¶

Type:: integer

Requested total number of points in the initial grid, meant to be used when distance-coordinates is different than the parameters used to set the prior bounds. Note that the actual number of points may be higher than requested. Our approach is to guess an equal number of points along each dimension, apply the prior bounds, and then increase the number of points until total-points has been met or exceeded.

points-per-side¶

Type:: integer

The number of grid points per dimension for intrinsic grid. NOTE: This will be overwritten if total-points is set.

overlap-threshold¶

Type:: float

If using overlap_bank, this number is used as the overlap threshold for the initial grid.

mc-min¶

Type:: float

Restrict $\mathcal{M}_{\mathrm{c}} \geq \mathcal{M}_{\mathrm{c,min}}$.

mc-max¶

Type:: float

Restrict $\mathcal{M}_{\mathrm{c}} \leq \mathcal{M}_{\mathrm{c,max}}$.

InitialGridSetup¶

There are several different modes one can specify the initial grid setup with. Each one is listed as a different sub-section in this document, but in an actual config file they are all part of the InitialGridSetup section.

overlap_bank¶

overlap_bank¶

Type:: string

The overlaps from here will be used to decide the initial grid region.

initial_region¶

initial_region¶

Type:: dictionary

Specify the upper and lower boundaries of initial grid region for each grid parameter. If the grid is in 2D, the dict keys should include parameters from distance_coordinates. If the grid is in 4D and distance_coordinates is mu1_mu2_q_spin2z, the dict keys should be [mu1, mu2,q,spin2z]. If grid is in 4D, but distance_coordinates contains two parameters, the dict keys should include the parameter from distance_coordinates and two spin parameters. Allowed set of spin parameter are [spin1z, spin2z] and [chi_eff, chi_a].

search_bias_bounds¶

search_bias_bounds_spec¶

Type:: string
Default:: rapidpe_rift_pipe.config_files.search_bias_bounds/default.json

Specify the boundaries for the initial grid based on a fit to the search bias. The default points to a fit to GstLAL search biases on MDC data.

svd_bounds¶

svd_bounds_file¶

Type:: string

TODO

svd_depth_json¶

Type:: string

Should be a JSON file with a list of dictionaries of the form:

{"bounds": {"param0": [param0_min, param0_max],
            "param1": [param1_min, param1_max]},
 "fudge_factors": {"param0": fudge_factor_0,
                   "param1": fudge_factor_1},
 "svd_depth": depth}

For a given trigger, we find the dictionary for which it falls in the bounds for each parameter, and then set the initial region to enclose the svd_depth highest-SNR SVD bins, and add on the fudge factor (as a fraction of the initial range) to each parameter’s limits.

svd_bin_params¶

Type:: list of strings
Default:: [mchirp, eta]

TODO

GridRefine¶

The arguments in this section are used by exe_grid_refine.

distance_coordinates¶

Type:: string
Default:: N/A

The mass coordinates in which the intrinsic grid is rectilinear. Used for both initial grid and grid refinements. Choices are:

mchirp_q
mchirp_eta
mtotal_q
tau0_tau3
mu1_mu2_q_spin2z

no-exact-match¶: Loosen criteria that the input intrinsic point must be a member of the input template bank.

verbose¶: Produce verbose output.

intrinsic-param¶

Type:: list of strings
Default:: [mass1, mass2]

Adapt the grid in these intrinsic parameter.

overlap-thresh¶

Type:: float between 0.0 and 1.0

Points whose marginal likelihood are within this fraction of the maximum likelihood point will be considered for refinement.

For example, 1.0 would consider all points, 0.0 would only consider the maximum likelihood point, and 0.9 would consider points with marginal likelihoods at least 0.1 times the maximum likelihood value.

LikelihoodIntegration¶

The arguments in this section are used by exe_integration_extrinsic_likelihood. Use any variable that exe_integration_extrinsic_likelihood can take. Underscores in parameter names will be converted to hyphens, and two hyphens will precede each argument. If you want to use a command line switch like --foo, you need to set the configuration variable foo to the empty string, i.e., foo=.

For example:

x=y will be converted to --x y
arg_a=foo will be converted to --arg-a foo
has_no_arg= will be converted to --has-no-arg

Pastro¶

The arguments in this section are used for the $p_{\mathrm{astro}}$ calculation.

Configuration¶

General¶

Event¶

gid¶

sid¶

injections¶

InitialGridOnly¶

InitialGridSetup¶

overlap_bank¶

initial_region¶

search_bias_bounds¶

svd_bounds¶

GridRefine¶

LikelihoodIntegration¶

Pastro¶

RapidPE/RIFT Pipeline

Navigation

Related Topics