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

Built-in Methods

 __len__ (self)
 Return the number of run specifications.

Runs

 add_run_specification (self, run_specification)
 Add a run specification to the list.
 get_lists_of_run_options (self)
 Return the lists of nvp options corresponding to all runs.
 get_executable_path (self)
 Get the executable path.
 build_run_commands (self)
 Build all the run commands from the list of specifications, and return them as a list.
 run (self, output_directory, nb_instances=1)
 Start all the runs in the list.

Detailed Description

A list of run specifications. It manages also the start of the runs, in particular when several instances of the same run are required.

Member Function Documentation

◆ __len__()

__len__ ( self)

Return the number of run specifications.

◆ add_run_specification()

add_run_specification ( self,
run_specification )

Add a run specification to the list.

◆ build_run_commands()

build_run_commands ( self)

Build all the run commands from the list of specifications, and return them as a list.

◆ get_executable_path()

get_executable_path ( self)

Get the executable path.

If there is no run, returns an empty string.

◆ get_lists_of_run_options()

get_lists_of_run_options ( self)

Return the lists of nvp options corresponding to all runs.

◆ run()

run ( self,
output_directory,
nb_instances = 1 )

Start all the runs in the list.

Each run is started in the output directory. The second options indicate the numberr of time each run has to be started. If it is started more than once, a temporary directory is created and the runs are started from this temporary directory; when a run terminates, the created output data is moved in the output directory and a tag identifying the instance number is added to the output data name.