gwin.workflow module

Module that contains functions for setting up the inference workflow.

gwin.workflow.make_inference_1d_posterior_plots(workflow, inference_file, output_dir, parameters=None, analysis_seg=None, tags=None)[source]
gwin.workflow.make_inference_acceptance_rate_plot(workflow, inference_file, output_dir, name='inference_rate', analysis_seg=None, tags=None)[source]

Sets up the acceptance rate plot in the workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • inference_file (pycbc.workflow.File) – The file with posterior samples.
  • output_dir (str) – The directory to store result plots and files.
  • name (str) – The name in the [executables] section of the configuration file to use.
  • analysis_segs ({None, glue.segments.Segment}) – The segment this job encompasses. If None then use the total analysis time from the workflow.
  • tags ({None, optional}) – Tags to add to the inference executables.
Returns:

A list of result and output files.
Return type:

pycbc.workflow.FileList
gwin.workflow.make_inference_inj_plots(workflow, inference_files, output_dir, parameters, name='inference_recovery', analysis_seg=None, tags=None)[source]

Sets up the recovered versus injected parameter plot in the workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • inference_files (pycbc.workflow.FileList) – The files with posterior samples.
  • output_dir (str) – The directory to store result plots and files.
  • parameters (list) – A list of parameters. Each parameter gets its own plot.
  • name (str) – The name in the [executables] section of the configuration file to use.
  • analysis_segs ({None, glue.segments.Segment}) – The segment this job encompasses. If None then use the total analysis time from the workflow.
  • tags ({None, optional}) – Tags to add to the inference executables.
Returns:

A list of result and output files.
Return type:

pycbc.workflow.FileList
gwin.workflow.make_inference_posterior_plot(workflow, inference_file, output_dir, parameters=None, name='inference_posterior', analysis_seg=None, tags=None)[source]

Sets up the corner plot of the posteriors in the workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • inference_file (pycbc.workflow.File) – The file with posterior samples.
  • output_dir (str) – The directory to store result plots and files.
  • parameters (list) – A list of parameters to plot.
  • name (str) – The name in the [executables] section of the configuration file to use.
  • analysis_segs ({None, glue.segments.Segment}) – The segment this job encompasses. If None then use the total analysis time from the workflow.
  • tags ({None, optional}) – Tags to add to the inference executables.
Returns:

A list of result and output files.
Return type:

pycbc.workflow.FileList
gwin.workflow.make_inference_prior_plot(workflow, config_file, output_dir, sections=None, name='inference_prior', analysis_seg=None, tags=None)[source]

Sets up the corner plot of the priors in the workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • config_file (pycbc.workflow.File) – The WorkflowConfigParser parasable inference configuration file..
  • output_dir (str) – The directory to store result plots and files.
  • sections (list) – A list of subsections to use.
  • name (str) – The name in the [executables] section of the configuration file to use.
  • analysis_segs ({None, glue.segments.Segment}) – The segment this job encompasses. If None then use the total analysis time from the workflow.
  • tags ({None, optional}) – Tags to add to the inference executables.
Returns:

A list of result and output files.
Return type:

pycbc.workflow.FileList
gwin.workflow.make_inference_samples_plot(workflow, inference_file, output_dir, parameters=None, name='inference_samples', analysis_seg=None, tags=None)[source]
gwin.workflow.make_inference_summary_table(workflow, inference_file, output_dir, variable_params=None, name='inference_table', analysis_seg=None, tags=None)[source]

Sets up the corner plot of the posteriors in the workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • inference_file (pycbc.workflow.File) – The file with posterior samples.
  • output_dir (str) – The directory to store result plots and files.
  • variable_params (list) – A list of parameters to use instead of [variable_params].
  • name (str) – The name in the [executables] section of the configuration file to use.
  • analysis_segs ({None, glue.segments.Segment}) – The segment this job encompasses. If None then use the total analysis time from the workflow.
  • tags ({None, optional}) – Tags to add to the inference executables.
Returns:

A list of result and output files.
Return type:

pycbc.workflow.FileList
gwin.workflow.setup_foreground_inference(workflow, coinc_file, single_triggers, tmpltbank_file, insp_segs, insp_data_name, insp_anal_name, dax_output, out_dir, tags=None)[source]

Creates workflow node that will run the inference workflow.

Parameters:
  • workflow (pycbc.workflow.Workflow) – The core workflow instance we are populating
  • coinc_file (pycbc.workflow.File) – The file associated with coincident triggers.
  • single_triggers (list of pycbc.workflow.File) – A list cointaining the file objects associated with the merged single detector trigger files for each ifo.
  • tmpltbank_file (pycbc.workflow.File) – The file object pointing to the HDF format template bank
  • insp_segs (SegFile) – The segment file containing the data read and analyzed by each inspiral job.
  • insp_data_name (str) – The name of the segmentlist storing data read.
  • insp_anal_name (str) – The name of the segmentlist storing data analyzed.
  • dax_output (str) – The name of the output DAX file.
  • out_dir (path) – The directory to store inference result plots and files
  • tags ({None, optional}) – Tags to add to the inference executables