bilby_pipe.asimov.online

Bilby Pipeline Specifications

Classes

BilbyOnline

Bilby Pipeline---Online Replication Configuration.

Module Contents

class bilby_pipe.asimov.online.BilbyOnline(production, category=None)[source]

Bases: asimov.pipelines.Bilby

Bilby Pipeline—Online Replication Configuration.

Parameters:

productionasimov.Production: The production object.
categorystr, optional, default=”C01_offline”: The category of the job.

Raises:

PipelineException: Should a non BilbyOnline production be used to initiate the run

name = 'bilbyonline'[source]

STATUS[source]

config_template = ''[source]

event_id = None[source]

build_dag(dryrun=False)[source]

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

Parameters:

dryrunbool, optional, default=False: If true commands will not be run and will instead be printed to standard out.

Raises:

PipelineException: Raised if the construction of the DAG fails.

resolve_grace_id() → str[source]

Establish the correct GID for the selected event

Returns:

grace_idstr: GraceDB Event ID (Gname)

Raises:

ValueError: Raised when GraceID cannot be identified from metadata or cannot be found on GraceDB

get_gname_from_sname(sname) → str[source]

Gets the preferred event Gname from the given Sname. Will retrieve the preferred event.

Parameters:

snamestr: GraceDB ID for the Superevent (Sname).

Returns:

gnamestr: GraceDB ID for the preferred Event (Gname).

Raises:

ValueError: If Sname does not recover an associated Gname

mass_settings(json_data) → tuple[str, str][source]

Determines settings for run based on best fitting template chirp mass.

Parameters:

json_datadict: GraceDB meta data.

Returns:

settings_fpstr: Path to settings for binary type.
likelihood_modestr: Contains the ROQ type to use.

Raises:

ValueError: If settings cannot be found or the chirp mass is incompatible with setting types

psd_file(json_data) → str[source]

Establishes which file contains the PSD information

Parameters:

json_datadict: Contains the metadata retrieved from GraceDB

Returns:

psd_filestr: Path to XML file containing PSD information

Raises:

ValueError: If unable to retrieve a PSD XML from GraceDB

submit_dag(dryrun=False)[source]

Submit a DAG file to the condor cluster

Parameters:

dryrunbool, optional, default=False: If true, the DAG will not be submitted but all commands will be printed to standard out.

Returns:

int: The cluster ID assigned to the running DAG file.
PipelineLogger: The pipeline logger message.

Raises:

PipelineException: Raised if the pipeline fails to submit the job.

after_completion()[source]