bilby_pipe.asimov.asimov

Bilby Pipeline specification.

Classes

Bilby

The Bilby Pipeline.

Module Contents

class bilby_pipe.asimov.asimov.Bilby(production, category=None)

Bases: asimov.pipeline.Pipeline

The Bilby Pipeline.

Parameters:

productionasimov.Production

The production object.

categorystr, optional

The category of the job. Defaults to “C01_offline”.

name = 'Bilby_Native'

STATUS

config_template = ''

detect_completion()

Check for the production of the posterior file to signal that the job has completed.

before_submit()

Pre-submit hook.

build_dag(psds=None, user=None, clobber_psd=False, dryrun=False)

Construct a DAG file in order to submit a production to the condor scheduler using bilby_pipe.

Parameters:

productionstr

The production name.

psdsdict, optional

The PSDs which should be used for this DAG. If no PSDs are provided the PSD files specified in the ini file will be used instead.

userstr

The user accounting tag which should be used to run the job.

dryrun: bool

If set to true the commands will not be run, but will be printed to standard output. Defaults to False.

Raises:

PipelineException

Raised if the construction of the DAG fails.

submit_dag(dryrun=False)

Submit a DAG file to the condor cluster.

Parameters:

dryrunbool

If set to true the DAG will not be submitted, but all commands will be printed to standard output instead. Defaults to False.

Returns:

int

The cluster ID assigned to the running DAG file.

PipelineLogger

The pipeline logger message.

Raises:

PipelineException

This will be raised if the pipeline fails to submit the job.

Notes

This overloads the default submission routine, as bilby seems to store its DAG files in a different location

collect_assets()

Gather all of the results assets for this job.

samples(absolute=False)

Collect the combined samples file for PESummary.

after_completion()

collect_logs()

Collect all of the log files which have been produced by this production and return their contents as a dictionary.

check_progress()

Check the convergence progress of a job.

classmethod read_ini(filepath)

Read and parse a bilby configuration file.

Note that bilby configurations are property files and not compliant ini configs.

Parameters:

filepath: str

The path to the ini file.

html()

Return the HTML representation of this pipeline.

resurrect()

Attempt to ressurrect a failed job.