Skip to content

Tools

It all starts with cmsRun which is the main entry point to all CMSSW code. Configuring it can be a pain so, for this reason, cmsDriver was built. Still, configuring cmsDriver can also be tedious for pipelines that require multiple steps of data fetching, configuring, simulating etc., so runTheMatrix.py was developed.

Those tools are available on LXPLUS machines, after creating a work area and activating a CMSSW environment by cmsenv.

scram

A software build and maintenance tool written in Python. It calls gmake under the hood.

It can clean, build, check and format the code.

Documentation on scram can be found here.

Extra Parameters

  • Scram also accepts extra flags which are passed directly to gmake such as --dry-run.
  • The USER_CXXFLAGS is an environmental variable which is used to pass arguments to g++.

See Building for more information and options.

cmsRun

Todo

TODO

The main entrypoint to execute CMSSW code. Probably never run by hand, it requires complicated configuration files to execute which are generated by other tools, described below.

cmsDriver.py

Todo

TODO

A Python tool to create cmsRun configuration files, which are in the form of Python3 code.

Resources

  1. Source code
  2. Twiki page

runTheMatrix.py

A wrapper script which is responsible of executing multi-step analysis/simulation recipes by configuring cmsDriver.

It is examined in more detail in the Workflows section