MadGraphSystematicsUtils.py

Go to the documentation of this file.

# Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
 
# utils to set systematics according to base fragment
 
# use some helper functions from MadGraphUtils
import ast
from MCJobOptionUtils.LHAPDFsupport import get_lhapdf_id_and_name
 
from AthenaCommon import Logging
mgsyslog = Logging.logging.getLogger('MadGraphSysUtils')
 
SYSTEMATICS_WEIGHT_INFO="MUR%(mur).1f_MUF%(muf).1f_PDF%(pdf)i"
SYSTEMATICS_WEIGHT_INFO_ALTDYNSCALES="MUR%(mur).1f_MUF%(muf).1f_DYNSCALE%(dyn)i_PDF%(pdf)i"
 
#==================================================================================
# main function: figure out run_card arguments that need to be set
# depends on
# * base fragment
# * NLO vs LO
# * MadGraph version
def get_pdf_and_systematic_settings(the_base_fragment,isNLO,useNLOotf=False):
 
    if not isNLO:
        useNLOotf=False
        
    
    runcard_settings={}
    runcard_systematics_arguments={}
    
    basefragment_settings={}
    basefragment_settings['central_pdf']=None
    basefragment_settings['alternative_pdfs']=None
    basefragment_settings['pdf_variations']=None
    basefragment_settings['scale_variations']=None
    basefragment_settings['alternative_dynamic_scales']=None
    for s in basefragment_settings:
        if s in the_base_fragment:
            if isinstance(basefragment_settings[s],list) and len(basefragment_settings[s])==0:
                continue
            basefragment_settings[s]=the_base_fragment[s]
        else:
            if s=='central_pdf':               
                raise RuntimeError('No "central_pdf" configured in base fragment')   
            if s=='alternative_dynamic_scales':
                continue
            mgsyslog.warning('base fragment or pdf settings does not define "'+s+'"')
 
    
    for s in basefragment_settings:
        if s=='central_pdf':
            if not isinstance(basefragment_settings[s],int):
                raise RuntimeError(s+', configured in base fragment, has to be an integer')
            continue
        if basefragment_settings[s] is None:
            continue
        if s=='scale_variations':
            if not isinstance(basefragment_settings[s],list):
                raise RuntimeError(s+', configured in base fragment, has to be a list of numbers')
            for pdf in basefragment_settings[s]:
                if not isinstance(pdf,float) and not isinstance(pdf,int):
                    raise RuntimeError(s+', configured in base fragment, has to be a list of numbers')
        else:
            if not isinstance(basefragment_settings[s],list):
                raise RuntimeError(s+', configured in base fragment, has to be a list of integers')
            for element in basefragment_settings[s]:
                if not isinstance(element,int) or not element>0:
                    raise RuntimeError(s+', configured in base fragment, has to be a list of positive integers')
    
    
    if basefragment_settings['alternative_pdfs'] is not None:
        # if a PDF set is included as variation (i.e. nominal + error pdf) there is no need to have it as alternative pdf (i.e. only nominal)
        if basefragment_settings['pdf_variations'] is not None:
            basefragment_settings['alternative_pdfs']=[ a for a in basefragment_settings['alternative_pdfs']  if a not in basefragment_settings['pdf_variations'] ]
        # the central pdf does not need to be included as alternative PDF
        if basefragment_settings['central_pdf'] in basefragment_settings['alternative_pdfs']:
            basefragment_settings['alternative_pdfs'].remove(basefragment_settings['central_pdf'])
  
    
    runcard_settings['pdlabel']='lhapdf'
    runcard_settings['lhaid']=str(basefragment_settings['central_pdf'])
 
    # turn on LO systematics and use new systematics script
    if not useNLOotf:
        if basefragment_settings['alternative_dynamic_scales'] is not None:
             runcard_systematics_arguments['weight_info']=SYSTEMATICS_WEIGHT_INFO_ALTDYNSCALES
        else:
            runcard_systematics_arguments['weight_info']=SYSTEMATICS_WEIGHT_INFO
        runcard_systematics_arguments['remove_wgts']='".*MUR0.5_MUF2.0.*|.*MUR2.0_MUF0.5.*"'
            
        runcard_settings['systematics_program']='none'
        for s in ['alternative_pdfs','pdf_variations','scale_variations']:
            if basefragment_settings[s] is not None and len(basefragment_settings[s])>0:
                # set use_syst true if some variations are used
                if isNLO:
                    runcard_settings['store_rwgt_info']='True'
                else:
                    runcard_settings['use_syst']='True'
                # use the MadGraph systematics program != syscalc
                runcard_settings['systematics_program']='systematics'
                break
 
    
    if useNLOotf:
        # pdf weights with NLO syntax
        if basefragment_settings['pdf_variations'] is not None and basefragment_settings['central_pdf'] in basefragment_settings['pdf_variations']:
            runcard_settings['reweight_PDF']='True'
        else:
            runcard_settings['reweight_PDF']='False'
        if basefragment_settings['pdf_variations'] is not None:
            for v in basefragment_settings['pdf_variations']:
                if v==basefragment_settings['central_pdf']:
                    continue
                runcard_settings['lhaid']+=' '+str(v)
                runcard_settings['reweight_PDF']+=' True'
        if basefragment_settings['alternative_pdfs'] is not None:
            for a in basefragment_settings['alternative_pdfs']:
                runcard_settings['lhaid']+=' '+str(a)
                runcard_settings['reweight_PDF']+=' False'
            
    else: #use the new python systematics module
        sys_pdfs=[]
        if basefragment_settings['pdf_variations'] is not None:
            for v in basefragment_settings['pdf_variations']:
                sys_pdfs.append(get_lhapdf_id_and_name(v)[1])
        if basefragment_settings['alternative_pdfs'] is not None:
            for a in basefragment_settings['alternative_pdfs']:
                sys_pdfs.append(get_lhapdf_id_and_name(a)[1]+'@0')
        if len(sys_pdfs)>0:
            runcard_systematics_arguments['pdf']=','.join(sys_pdfs)
        if isNLO:
            runcard_settings['reweight_PDF']='False'
            
 
    
    if basefragment_settings['scale_variations'] is None and isNLO:
        runcard_settings['reweight_scale']='False'
    if basefragment_settings['scale_variations'] is not None:
        if useNLOotf:
            runcard_settings['reweight_scale']='True'
            runcard_settings['rw_rscale']=' '.join([str(s) for s in basefragment_settings['scale_variations']])
            runcard_settings['rw_fscale']=' '.join([str(s) for s in basefragment_settings['scale_variations']])
        else:
            runcard_systematics_arguments['muf']=','.join([str(s) for s in basefragment_settings['scale_variations']])
            runcard_systematics_arguments['mur']=','.join([str(s) for s in basefragment_settings['scale_variations']])
            runcard_systematics_arguments['dyn']='-1'
            if isNLO:
                runcard_settings['reweight_scale']='False'
 
    if basefragment_settings['alternative_dynamic_scales'] is not None:
        if useNLOotf:
            raise RuntimeError('Cannot reweight to alternative dynamic scales using the NLO OTF module')
        else:
            runcard_systematics_arguments['dyn']=','.join([str(s) for s in [-1]+basefragment_settings['alternative_dynamic_scales']])
            
    if not useNLOotf:
        runcard_settings['systematics_arguments']=write_systematics_arguments(runcard_systematics_arguments)
 
    return runcard_settings
 
 
#==================================================================================
# convert settings from the syscalc syntax to the new systematics syntax which is steered via "systematics_arguments"
# will modify the dict and also return new setting
def convertSysCalcArguments(extras):
    if 'systematics_program' in extras:
        if extras['systematics_program'].lower=='none':
            mgsyslog.warning('no need to convert systematics arguments if systematcs are not run')
            return
        if extras['systematics_program'].lower=='syscalc':
            mgsyslog.warning('systematics already correct for chosen systematics program SysCalc')
            return
 
    if 'systematics_arguments' in extras:
        mgsyslog.warning('systematics_arguments already defined, will be overwritten')
    systematics_arguments={}
    systematics_arguments['dyn']='-1'
    systematics_arguments['mur']='1'
    systematics_arguments['muf']='1'
        
    if 'sys_scalefact' in extras:
        sys_scalefact=extras['sys_scalefact']
        extras.pop('sys_scalefact')
        if len(sys_scalefact.split())>0:
            systematics_arguments['mur']=','.join(sys_scalefact.split())
            systematics_arguments['muf']=','.join(sys_scalefact.split())
 
    systematics_arguments['pdf']='central'
    if 'sys_pdf' in extras:
        sys_pdf=extras['sys_pdf']
        extras.pop('sys_pdf')
        spl=sys_pdf.replace('&&',' ').split()
        i=0
        pdfs=[]
        while i <len(spl):
            pdfs.append(spl[i])
            if i+1<len(spl) and spl[i+1].isdigit() and int(spl[i+1])<1000:
                pdfs[-1]+='@'+str(int(spl[i+1])-1)
                i+=1
            i+=1
        if len(pdfs)>0:
            systematics_arguments['pdf']=','.join(pdfs)
    systematics_arguments['weight_info']=SYSTEMATICS_WEIGHT_INFO
    extras['systematics_arguments']=write_systematics_arguments(systematics_arguments)
    return extras['systematics_arguments']
 
def write_systematics_arguments(systematics_arguments):
    return '['+','.join(["'--"+k+"="+systematics_arguments[k]+"'" for k in systematics_arguments])+']'
 
#==================================================================================
# create a map from the 'systematics_arguments' run card argument
def parse_systematics_arguments(sys_args):
    parsed={}
    if sys_args.strip().startswith('['):
        argument_list = ast.literal_eval(sys_args)
        for a in argument_list:
            key,value=parse_systematics_argument(a)
            parsed[key]=value
    else:
        arg=sys_args.replace("'",'').replace('"','')
        key,value=parse_systematics_argument(arg)
    return parsed
 
def parse_systematics_argument(sys_arg):
    spl=sys_arg.strip().split('=')
    return (spl[0].strip()[2:],spl[1].strip())
 
#==================================================================================
# these arguments steer systematics
def systematics_run_card_options(isNLO):
    if isNLO:
        return ['pdlabel','lhaid','reweight_PDF','reweight_scale','rw_rscale','rw_fscale','store_rwgt_info','systematics_arguments' ]
    else:
        return  ['pdlabel','lhaid','use_syst','sys_scalefact','sys_pdf','systematics_arguments']