Loading [MathJax]/extensions/TeX/AMSsymbols.js
LAL 7.7.0.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
lal.pipeline.SqliteJob Class Reference

Detailed Description

A cbc sqlite job adds to CondorDAGJob and AnalysisJob features common to jobs which read or write to a sqlite database.

Of note, the universe is always set to local regardless of what's in the cp file, the extension is set to None so that it may be set by individual SqliteNodes, log files do not have macrogpsstarttime and endtime in them, and get_env is set to True.

Definition at line 2964 of file pipeline.py.

Inherits lal.pipeline.CondorDAGJob, and lal.pipeline.AnalysisJob.

Inherited by lal.pipeline.LigolwSqliteJob.

Public Member Functions

def __init__ (self, cp, sections, exec_name)
 
def set_exec_name (self, exec_name)
 Set the exec_name name. More...
 
def get_exec_name (self)
 Get the exec_name name. More...
 
- Public Member Functions inherited from lal.pipeline.CondorDAGJob
def __init__ (self, universe, executable)
 universe = the condor universe to run the job in. More...
 
def create_node (self)
 Create a condor node from this job. More...
 
def set_grid_site (self, site)
 Set the grid site to run on. More...
 
def get_grid_site (self)
 Return the grid site for this node. More...
 
def add_var_opt (self, opt, short=False)
 Add a variable (or macro) option to the condor job. More...
 
def add_var_condor_cmd (self, command)
 Add a condor command to the submit file that allows variable (macro) arguments to be passes to the executable. More...
 
def add_var_arg (self, arg_index, quote=False)
 Add a command to the submit file to allow variable (macro) arguments to be passed to the executable. More...
 
- Public Member Functions inherited from lal.pipeline.CondorJob
def __init__ (self, universe, executable, queue)
 
def get_executable (self)
 Return the name of the executable for this job. More...
 
def set_executable (self, executable)
 Set the name of the executable for this job. More...
 
def get_universe (self)
 Return the condor universe that the job will run in. More...
 
def set_universe (self, universe)
 Set the condor universe for the job to run in. More...
 
def get_grid_type (self)
 Return the grid type of the job. More...
 
def set_grid_type (self, grid_type)
 Set the type of grid resource for the job. More...
 
def get_grid_server (self)
 Return the grid server on which the job will run. More...
 
def set_grid_server (self, grid_server)
 Set the grid server on which to run the job. More...
 
def get_grid_scheduler (self)
 Return the grid scheduler. More...
 
def set_grid_scheduler (self, grid_scheduler)
 Set the grid scheduler. More...
 
def set_executable_installed (self, installed)
 If executable installed is true, then no copying of the executable is done. More...
 
def get_executable_installed (self)
 return whether or not the executable is installed More...
 
def add_condor_cmd (self, cmd, value)
 Add a Condor command to the submit file (e.g. More...
 
def get_condor_cmds (self)
 Return the dictionary of condor keywords to add to the job. More...
 
def add_input_file (self, filename)
 Add filename as a necessary input file for this DAG node. More...
 
def add_output_file (self, filename)
 Add filename as a output file for this DAG node. More...
 
def add_checkpoint_file (self, filename)
 Add filename as a checkpoint file for this DAG job. More...
 
def get_input_files (self)
 Return list of input files for this DAG node. More...
 
def get_output_files (self)
 Return list of output files for this DAG node. More...
 
def get_checkpoint_files (self)
 Return a list of checkpoint files for this DAG node. More...
 
def add_arg (self, arg)
 Add an argument to the executable. More...
 
def add_file_arg (self, filename)
 Add a file argument to the executable. More...
 
def get_args (self)
 Return the list of arguments that are to be passed to the executable. More...
 
def add_opt (self, opt, value)
 Add a command line option to the executable. More...
 
def get_opt (self, opt)
 Returns the value associated with the given command line option. More...
 
def add_file_opt (self, opt, filename)
 Add a command line option to the executable. More...
 
def get_opts (self)
 Return the dictionary of opts for the job. More...
 
def add_short_opt (self, opt, value)
 Add a command line option to the executable. More...
 
def get_short_opts (self)
 Return the dictionary of short options for the job. More...
 
def add_ini_opts (self, cp, section)
 Parse command line options from a given section in an ini file and pass to the executable. More...
 
def set_notification (self, value)
 Set the email address to send notification to. More...
 
def set_log_file (self, path)
 Set the Condor log file. More...
 
def set_stdin_file (self, path)
 Set the file from which Condor directs the stdin of the job. More...
 
def get_stdin_file (self)
 Get the file from which Condor directs the stdin of the job. More...
 
def set_stderr_file (self, path)
 Set the file to which Condor directs the stderr of the job. More...
 
def get_stderr_file (self)
 Get the file to which Condor directs the stderr of the job. More...
 
def set_stdout_file (self, path)
 Set the file to which Condor directs the stdout of the job. More...
 
def get_stdout_file (self)
 Get the file to which Condor directs the stdout of the job. More...
 
def set_sub_file (self, path)
 Set the name of the file to write the Condor submit file to when write_sub_file() is called. More...
 
def get_sub_file (self)
 Get the name of the file which the Condor submit file will be written to when write_sub_file() is called. More...
 
def write_sub_file (self)
 Write a submit file for this Condor job. More...
 
- Public Member Functions inherited from lal.pipeline.AnalysisJob
def __init__ (self, cp)
 
def get_config (self, sec, opt)
 Get the configration variable in a particular section of this jobs ini file. More...
 
def set_channel (self, channel)
 Set the name of the channel that this job is filtering. More...
 
def channel (self)
 Returns the name of the channel that this job is filtering. More...
 

Constructor & Destructor Documentation

◆ __init__()

def lal.pipeline.SqliteJob.__init__ (   self,
  cp,
  sections,
  exec_name 
)
Parameters
cpa ConfigParser object from which options are read
sectionslist of sections in cp to get added options
exec_namethe name of the sql executable

Reimplemented from lal.pipeline.CondorDAGJob.

Reimplemented in lal.pipeline.LigolwSqliteJob.

Definition at line 2970 of file pipeline.py.

Member Function Documentation

◆ set_exec_name()

def lal.pipeline.SqliteJob.set_exec_name (   self,
  exec_name 
)

Set the exec_name name.

Definition at line 2992 of file pipeline.py.

◆ get_exec_name()

def lal.pipeline.SqliteJob.get_exec_name (   self)

Get the exec_name name.

Definition at line 2998 of file pipeline.py.