Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
BM_Batch Class Reference

Loading

def set_dataset (self, dataset)
 Set the current dataset from an existing dataset. More...
 
def add_run_specification (self, run_specification)
 Add a simple run specification to the batch. More...
 
def load_dataset (self, directory, file_name_re=".*", recursive=False)
 Load the dataset from a directory. More...
 
def check_specification (self)
 Check that the loaded specification is correct. More...
 
def load_run_specification (self, file_name)
 Load the specification of the runs from a specification file. More...
 

Building the Runs

def build_run_commands (self)
 Builds the run specifications of each run of the batch, and return them. More...
 
def split_per_IFO (self)
 Split the batch such that each new batch is invariant w.r.t the IFO. More...
 
def split_per_NFO (self)
 Split the batch such that each new batch is invariant w.r.t the NFO. More...
 
def split_per_selected_NFO_option (self, option_name)
 Split the batch such that the new batch is invariant w.r.t the input NFO name. More...
 
def split_per_selected_IFO_option (self, option_name)
 Split the batch such that the new batch is invariant w.r.t the input IFO name. More...
 
def split_per_selected_option (self, option_name)
 Split the batch such that the new batch is invariant w.r.t the input option. More...
 
def split_per_selected_options (self, option_names)
 Same as previous but do it recursively over a list of option names. More...
 

Accessing the Runs

def get_output_directory (self)
 Simple access to the directory where the runs of the batch are run. More...
 
def set_output_directory_prefix (self, prefix)
 Sets a prefix for the output directory where the runs of the batch are run. More...
 
def set_output_directory (self, output_directory)
 Sets the output directory, where the runs of the batch are run. More...
 
def get_run_commands (self)
 Simple access to the run specification of each run. More...
 

Starting the Runs

def print_batch (self)
 Print all the run commands from the list of specifications. More...
 
def get_lists_of_run_options (self)
 Return a list of run options for each run in the batch. More...
 
def run (self, nb_instances=1)
 Does the runs nb_instances times. More...
 
def repeat (self, nb_instances)
 Synonym of run, but the number of instances has no default value. More...
 
def make_scripts (self)
 Make one file per execution instead of runnning them. More...
 

Detailed Description

Definition of a batch with a data set, and specification of runs. The functionnality are :

  • loading the batch from a couple (dataset, specification_file),
  • printing the commands to run, or running them directly,
  • splitting the batch onto several smaller batches where the IFO or NFO are identical.