caf_pbs_backend.py

# This steering file shows example setup for
# running the CAF using the PBS (qsub) batch system backend with multiple test calibrations.
# You will need to have data already from running calibration/examples/1_create_sample_DSTs.sh
# or just make your own and change the input data below.
 
# Not all of the configuration is strictly necessary, it's just to show some options
 
import basf2 as b2
 
import os
import sys
 
from ROOT.Belle2 import TestCalibrationAlgorithm
from caf.framework import Calibration, CAF
from caf import backends
 
b2.set_log_level(b2.LogLevel.INFO)
 
 
def main(argv):
    if len(argv) == 1:
        data_dir = argv[0]
    else:
        print("Usage: python3 caf_pbs_backend.py <data directory>")
        sys.exit(1)
 
    
    input_files_test = [os.path.join(os.path.abspath(data_dir), '*.root')]
 
    from caf.strategies import SequentialRunByRun
    
    calibrations = []
    for i in range(1, 3):
        col_test = b2.register_module('CaTest')
        col_test.set_name('Test{}'.format(i))  # Sets the prefix of the collected data in the datastore
        col_test.param('spread', 15)  # Proportional to the probability of algorithm requesting iteration
        col_test.param('granularity', 'run')  # Allows us to execute algorithm over all data, in one big IoV
 
        alg_test = TestCalibrationAlgorithm()
        # Since we're using several instances of the same test algorithm here, we still want the database entries to have
        # different names. TestCalibrationAlgorithm outputs to the database using the prefix name so we change it
        # slightly for each calibration. Not something you'd usually have to do.
        alg_test.setPrefix('Test{}'.format(i))  # Must be the same as colllector prefix
 
        cal_test = Calibration(name='TestCalibration{}'.format(i),
                               collector=col_test,
                               algorithms=alg_test,
                               input_files=input_files_test)
 
        # Some optional configuration ####
        # By default all input files are placed in one big job (-1), this allows you to specify a maxmimum so that
        # subjobs for each set of input files will be created
        cal_test.max_files_per_collector_job = 1
        # Some backends can have arguments passed to them e.g. queue type
        cal_test.backend_args = {"queue": "short"}
        # The maximium iteration number you will be allowed to reach before the Calibration just completes
        cal_test.max_iterations = 2
        # Since we're using the PBS batch system we'll up the heartbeat from the default to query for when the jobs are all
        # finished. No point spamming it
        cal_test.heartbeat = 15
        # The interval in seconds between full updates of the remaining collector jobs, default = 300
        # Checking every subjob can be a long process when you have a lot of them so it's best not to do it too often
        # After this interval the finished/remaining collector jobs will be printed
        cal_test.collector_full_update_interval = 60
        # Choosing an AlgorithmStrategy for each algorithm (here we just use the same for all of them)
        cal_test.strategies = SequentialRunByRun
        # The collector output file patterns you want to make sure are tracked by the CAF. By default only CollectorOutput.root
        # is used. All files are passed to the Algorithm.data_input function in order to set the input files of the algorithm
        cal_test.output_patterns.append("*.mille")
        
        calibrations.append(cal_test)
 
    
    cal_fw = CAF()
    # Add in our list of calibrations
    for cal in calibrations:
        cal_fw.add_calibration(cal)
    # Use the default PBS backend setup, can view the default options in calibration/data/backends.cfg
    cal_fw.backend = backends.PBS()
    # Start running
    cal_fw.run()
    print("End of CAF processing.")
 
 
if __name__ == "__main__":
    main(sys.argv[1:])