asimov.asimov.Dingo

asimov.asimov.Dingo(production, category=None)

The Dingo Pipeline.

Parameters

Name Type Description Default
production :class:asimov.Production The production object. required
category str The category of the job. Defaults to “C01_offline”. None

Attributes

Name Description
STATUS
config_template
logger
name

Methods

Name Description
after_completion
before_config Parse available networks before building the ini.
before_submit Pre-submit hook.
build_dag Construct a DAG file in order to submit a production to the
collect_assets Gather all of the results assets for this job.
collect_logs Collect all of the log files which have been produced by this production and
detect_completion Check for the production of the posterior file to signal that the job has completed.
detect_completion_processing
fmin_max_are_compatible Check if the network min/max frequencies are compatible with the data.
network_is_compatible Check if a network’s metadata is compatible with the production in prod_meta.
read_ini Read and parse a dingo configuration file.
resurrect Attempt to ressurrect a failed job.
samples Collect the combined samples files for PESummary.
submit_dag Submit a DAG file to the condor cluster.
upload_assets Upload the samples from this job.

after_completion

asimov.asimov.Dingo.after_completion()

before_config

asimov.asimov.Dingo.before_config(dryrun=False)

Parse available networks before building the ini.

before_submit

asimov.asimov.Dingo.before_submit()

Pre-submit hook.

build_dag

asimov.asimov.Dingo.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 DingoPipe.

Parameters

Name Type Description Default
production str The production name. required
psds dict 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. None
user str The user accounting tag which should be used to run the job. None
dryrun If set to true the commands will not be run, but will be printed to standard output. Defaults to False. False

Raises

Name Type Description
PipelineException Raised if the construction of the DAG fails.

collect_assets

asimov.asimov.Dingo.collect_assets()

Gather all of the results assets for this job.

collect_logs

asimov.asimov.Dingo.collect_logs()

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

detect_completion

asimov.asimov.Dingo.detect_completion()

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

detect_completion_processing

asimov.asimov.Dingo.detect_completion_processing()

fmin_max_are_compatible

asimov.asimov.Dingo.fmin_max_are_compatible(prod_meta, net_meta)

Check if the network min/max frequencies are compatible with the data.

Take possible domain updates and random frequency masking into account.

network_is_compatible

asimov.asimov.Dingo.network_is_compatible(prod_meta, net_meta)

Check if a network’s metadata is compatible with the production in prod_meta.

read_ini

asimov.asimov.Dingo.read_ini(filepath)

Read and parse a dingo configuration file.

Parameters

Name Type Description Default
filepath The path to the ini file. required

resurrect

asimov.asimov.Dingo.resurrect()

Attempt to ressurrect a failed job.

samples

asimov.asimov.Dingo.samples(absolute=False)

Collect the combined samples files for PESummary.

submit_dag

asimov.asimov.Dingo.submit_dag(dryrun=False)

Submit a DAG file to the condor cluster.

Parameters

Name Type Description Default
dryrun bool If set to true the DAG will not be submitted, but all commands will be printed to standard output instead. Defaults to False. False

Returns

Name Type Description
int The cluster ID assigned to the running DAG file.
PipelineLogger The pipeline logger message.

Raises

Name Type Description
PipelineException This will be raised if the pipeline fails to submit the job.

upload_assets

asimov.asimov.Dingo.upload_assets()

Upload the samples from this job.