inspiral_pipe Namespace Reference

Detailed Description

A module that contains the inspiral_pipe module code; used to construct condor dags.

Review Status

Names	Hash	Date
Florent, Sathya, Duncan Me, Jolien, Kipp, Chad	8a6ea41398be79c00bdc27456ddeb1b590b0f68e	2014-06-18

Actions

• In inspiral_pipe.py Fix the InsiralJob.___init___: fix the arguments
• On line 201, fix the comment or explain what the comment is meant to be

Classes
class	DAG
	A thin subclass of pipeline.CondorDAG. More...
class	InspiralJob
	A job class that subclasses pipeline.CondorDAGJob and adds some extra boiler plate items for gstlal inspiral jobs. More...
class	InspiralNode
	A node class that subclasses pipeline.CondorDAGNode that automates adding the node to the dag, makes sensible names and allows a list of parent nodes to be provided. More...
class	generic_job
	A generic job class which tends to do the "right" thing when given just an executable name but otherwise is a subclass of InspiralJob and thus pipeline.CondorDAGJob. More...
class	generic_node
	A generic node class which tends to do the "right" thing when given a job, a dag, parent nodes, a dictionary options relevant to the job, a dictionary of options related to input files and a dictionary of options related to output files. More...

Functions
def	which
	Like the which program to find the path to an executable.
def	condor_scratch_space
	A way to standardize the condor scratch space even if it changes condor_scratch_space() '_CONDOR_SCRATCH_DIR'.
def	log_path
	The stupid pet tricks to find log space on the LDG.
def	pipeline_dot_py_append_opts_hack
	A way to work around the dictionary nature of pipeline.py which can only record options once.
def	group
	group a list roughly according to the distribution in parts, e.g.
def	parse_cache_str
	A way to decode a command line option that specifies different bank caches for different detectors, e.g.,.
def	build_bank_groups
	given a dictionary of bank cache files keyed by ifo from .e.g., parse_cache_str(), group the banks into suitable size chunks for a single svd bank file according to numbanks.
def	T050017_filename
	A function to generate a T050017 filename.

Function Documentation

def inspiral_pipe.build_bank_groups	(		cachedict,
			numbanks = [2],
			maxjobs = None
	)

given a dictionary of bank cache files keyed by ifo from .e.g., parse_cache_str(), group the banks into suitable size chunks for a single svd bank file according to numbanks.

Note, numbanks can be should be a list and uses the algorithm in the group() function

Definition at line 294 of file inspiral_pipe.py.

def inspiral_pipe.condor_scratch_space

(

)

A way to standardize the condor scratch space even if it changes

condor_scratch_space()

'_CONDOR_SCRATCH_DIR'.

Definition at line 66 of file inspiral_pipe.py.

def inspiral_pipe.group	(		inlist,
			parts
	)

group a list roughly according to the distribution in parts, e.g.

A = range(12) B = [2,3] for g in group(A,B):

... print g ... [0, 1] [2, 3] [4, 5] [6, 7, 8] [9, 10, 11]

Definition at line 250 of file inspiral_pipe.py.

def inspiral_pipe.log_path

(

)

The stupid pet tricks to find log space on the LDG.

Defaults to checking TMPDIR first.

Definition at line 75 of file inspiral_pipe.py.

def inspiral_pipe.parse_cache_str

(

instr

)

A way to decode a command line option that specifies different bank caches for different detectors, e.g.,.

bankcache = parse_cache_str("H1=H1_split_bank.cache,L1=L1_split_bank.cache,V1=V1_split_bank.cache") bankcache

{'V1': 'V1_split_bank.cache', 'H1': 'H1_split_bank.cache', 'L1': 'L1_split_bank.cache'}

Definition at line 275 of file inspiral_pipe.py.

def inspiral_pipe.pipeline_dot_py_append_opts_hack	(		opt,
			vals
	)

A way to work around the dictionary nature of pipeline.py which can only record options once.

pipeline_dot_py_append_opts_hack("my-favorite-option", [1,2,3])

'1 –my-favorite-option 2 –my-favorite-option 3'

Definition at line 230 of file inspiral_pipe.py.

def inspiral_pipe.T050017_filename	(		instruments,
			description,
			start,
			end,
			extension,
			path = None
	)

A function to generate a T050017 filename.

Definition at line 313 of file inspiral_pipe.py.

def inspiral_pipe.which

(

prog

)

Like the which program to find the path to an executable.

which("ls")

'/bin/ls'

Definition at line 50 of file inspiral_pipe.py.