bilby_pipe.main
This module provides the code for the top-level interface for
bilby_pipe executable.
Classes
MainInput
|
An object to hold all the inputs to bilby_pipe |
Module Contents
-
class bilby_pipe.main.MainInput(args, unknown_args, perform_checks=True)[source]
Bases: bilby_pipe.input.Input
An object to hold all the inputs to bilby_pipe
-
known_args[source]
-
unknown_args[source]
-
property ini[source]
-
submit[source]
-
condor_job_priority[source]
-
create_summary[source]
-
scitoken_issuer[source]
-
container[source]
-
cosmology[source]
-
outdir[source]
The path to the directory where output will be stored
-
label[source]
-
log_directory[source]
The top-level directory for the log directories
-
accounting[source]
-
accounting_user[source]
-
sampler[source]
-
sampling_seed[source]
-
detectors[source]
A list of the detectors to include, e.g., [‘H1’, ‘L1’]
-
coherence_test[source]
-
data_dict[source]
-
channel_dict[source]
-
frame_type_dict[source]
-
data_find_url[source]
-
data_find_urltype[source]
-
n_parallel[source]
-
transfer_files[source]
-
additional_transfer_paths[source]
-
osg[source]
-
desired_sites[source]
-
property analysis_executable[source]
-
analysis_executable_parser[source]
-
result_format[source]
-
final_result[source]
-
final_result_nsamples[source]
-
webdir[source]
-
email[source]
-
property notification[source]
-
queue[source]
-
existing_dir[source]
-
scheduler[source]
-
scheduler_args[source]
-
scheduler_module[source]
-
scheduler_env[source]
-
scheduler_analysis_time[source]
-
disable_hdf5_locking[source]
-
property environment_variables[source]
-
property getenv[source]
-
waveform_approximant[source]
-
time_reference[source]
-
reference_frame[source]
-
likelihood_type[source]
-
duration[source]
-
phase_marginalization[source]
-
prior_file[source]
-
prior_dict[source]
The input prior_dict from the ini (if given)
Note, this is not the bilby prior (see self.priors for that), this is
a key-val dictionary where the val’s are strings which are converting
into bilby priors in _get_priors()
-
default_prior[source]
-
minimum_frequency[source]
The minimum frequency
If a per-detector dictionary is given, this will return the minimum
frequency value. To access the dictionary,
see self.minimum_frequency_dict
-
enforce_signal_duration[source]
-
run_local[source]
-
generation_pool[source]
-
property local_generation[source]
-
local_plot[source]
-
post_trigger_duration[source]
-
ignore_gwpy_data_quality_check[source]
-
trigger_time[source]
-
deltaT[source]
-
gps_tuple[source]
-
gps_file[source]
The gps file containing the list of gps times
-
timeslide_file[source]
Timeslide file.
Timeslide file containing the list of timeslides to apply to each
detector’s start time.
-
gaussian_noise[source]
-
zero_noise[source]
-
property n_simulation[source]
-
injection[source]
-
injection_numbers[source]
-
injection_file[source]
-
injection_dict[source]
-
injection_waveform_arguments[source]
-
injection_waveform_approximant[source]
-
injection_frequency_domain_source_model[source]
-
generation_seed[source]
-
property request_disk[source]
-
property request_memory[source]
-
property request_memory_generation[source]
-
property request_cpus[source]
-
sampler_kwargs[source]
-
mpi_samplers = ['pymultinest'][source]
-
property use_mpi[source]
-
plot_node_needed = False[source]
-
postprocessing_executable[source]
-
postprocessing_arguments[source]
-
single_postprocessing_executable[source]
-
single_postprocessing_arguments[source]
-
summarypages_arguments[source]
-
psd_dict[source]
-
psd_maximum_duration[source]
-
psd_length[source]
Integer number of durations to use for generating the PSD
-
psd_fractional_overlap[source]
-
psd_start_time[source]
The PSD start time relative to segment start time
-
spline_calibration_envelope_dict[source]
-
extra_lines = [][source]
-
requirements = [][source]
-
property initialdir[source]
-
static check_source_model(args)[source]
Check the source model consistency with the approximant
-
static check_calibration_prior_boundary(args)[source]
-
check_cpu_parallelisation()[source]
-
check_injection()[source]
Check injection behaviour
If injections are requested, either use the injection-dict,
injection-file, or create an injection-file
-
bilby_pipe.main.write_complete_config_file(parser, args, inputs, input_cls=MainInput)[source]
-
bilby_pipe.main.create_main_parser()[source]
-
bilby_pipe.main.main()[source]
Top-level interface for bilby_pipe