cmake_newskeleton.py

Go to the documentation of this file.

# Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
# @file PyUtils.scripts.cmt_newanalysisalg
# @purpose streamline and ease the creation of new athena algs
# @author Will Buttinger
# @date February 2017
 
#Note - this code could use a serious rewrite, I just hacked it together to get something working
 
__version__ = "$Revision: 795362 $"
__author__ = "Will Buttinger"
__doc__ = "streamline and ease the creation of new AthAnalysisAlgorithm in a new package"
 

import os
import textwrap
import subprocess
import PyUtils.acmdlib as acmdlib
 
 
 

@acmdlib.command(
    name='cmake.new-skeleton'
    )
@acmdlib.argument(
    'pkgname',
    help="name of the new pkg"
    )
 
 
def main(args):
    """create a new skeleton package
 
    ex:
     $ acmd cmake new-skeleton MyPackage
    """
    sc = 0
    
    full_pkg_name = args.pkgname
 
    #make new package
    res = subprocess.getstatusoutput('acmd cmake new-pkg %s' % full_pkg_name)
    if res[0]!=0:
        print(":::  ERROR could not create new package")
        return -1
 
 
    #add algorithm
    res = subprocess.getstatusoutput('cd %s;acmd cmake new-analysisalg --newJobo %sAlg' % (full_pkg_name,full_pkg_name))
    if res[0]!=0:
        print(":::  ERROR could not create new alg")
        return -1
 
    pkg_name = full_pkg_name
 
    # overwrite CMakeLists with our skeleton
    with open(os.path.join(full_pkg_name,'CMakeLists.txt'), 'w') as req:
        print(textwrap.dedent("""\
        ## automatically generated CMakeLists.txt file
 
        # Declare the package
        atlas_subdir( %(pkg_name)s )
 
        # Declare external dependencies ... default here is to include ROOT
        find_package( ROOT COMPONENTS MathCore RIO Core Tree Hist )
 
        # Declare package as a library
        # Note the convention that library names get "Lib" suffix
        # Any package you depend on you should add
        # to LINK_LIBRARIES line below (see the example)
        atlas_add_library( %(pkg_name)sLib src/*.cxx
                           PUBLIC_HEADERS %(pkg_name)s
                           INCLUDE_DIRS ${ROOT_INCLUDE_DIRS}
                           LINK_LIBRARIES ${ROOT_LIBRARIES}
                                            AthAnalysisBaseCompsLib
        )
 
        # if you add athena components (tools, algorithms) to this package
        # these lines are needed so you can configure them in joboptions
        atlas_add_component( %(pkg_name)s src/components/*.cxx
                              NOCLIDDB
                              LINK_LIBRARIES %(pkg_name)sLib 
        )
      
        # if you add an application (exe) to this package
        # declare it like this (note convention that apps go in the util dir)
        # atlas_add_executable( MyApp util/myApp.cxx
        #                       LINK_LIBRARIES %(pkg_name)sLib
        # )
 
        # Install python modules, joboptions, and share content
        atlas_install_python_modules( python/*.py )
        atlas_install_joboptions( share/*.py )
        atlas_install_data( data/* )
        atlas_install_scripts( scripts/* )
        # You can access your data from code using path resolver, e.g.
        # PathResolverFindCalibFile("%(pkg_name)s/file.txt")
 
        
        """%locals()), file=req)
 
 
 
 
    #need to reconfigure cmake so it knows about the new files
    #rely on the WorkDir_DIR env var for this
#    workDir = os.environ.get("WorkDir_DIR")
#    if workDir == None:
#        print("::: ERROR No WorkDir_DIR env var, did you forget to source the setup.sh script?")
#        print("::: ERROR Please do this and reconfigure cmake manually!")
#    else:
#        print(":::  INFO Reconfiguring cmake %s/../." % workDir)
#        res = subprocess.getstatusoutput('cmake %s/../.' % workDir)
#        if res[0]!=0:
#            print (":::  WARNING reconfigure unsuccessful. Please reconfigure manually!")