Skip to content

Setup and Usage

Cloning a CMSSW release on your machine

Search for available releases

Search for available releases:

scram list CMSSW

This should result in some output like:

Listing installed projects available for platform >> slc7_amd64_gcc10 <<

--------------------------------------------------------------------------------
| Project Name  | Project Version          | Project Location                  |
--------------------------------------------------------------------------------

  CMSSW           CMSSW_12_0_0_pre3          
                                         --> /cvmfs/cms.cern.ch/slc7_amd64_gcc10/cms/cmssw/CMSSW_12_0_0_pre3
  CMSSW           CMSSW_12_0_0_pre4          
                                         --> /cvmfs/cms.cern.ch/slc7_amd64_gcc10/cms/cmssw/CMSSW_12_0_0_pre4
  CMSSW           CMSSW_12_0_0_pre5          
                                         --> /cvmfs/cms.cern.ch/slc7_amd64_gcc10/cms/cmssw/CMSSW_12_0_0_pre5
...
  CMSSW           CMSSW_12_3_DBG_X_2022-02-10-2300  
                                         --> /cvmfs/cms-ib.cern.ch/week1/slc7_amd64_gcc10/cms/cmssw/CMSSW_12_3_DBG_X_2022-02-10-2300
  CMSSW           CMSSW_12_3_SKYLAKEAVX512_X_2022-02-10-2300  
                                         --> /cvmfs/cms-ib.cern.ch/week1/slc7_amd64_gcc10/cms/cmssw/CMSSW_12_3_SKYLAKEAVX512_X_2022-02-10-2300
  CMSSW           CMSSW_12_3_X_2022-02-11-1100  
                                         --> /cvmfs/cms-ib.cern.ch/week1/slc7_amd64_gcc10/cms/cmssw-patch/CMSSW_12_3_X_2022-02-11-1100

Create a CMSSW area

Once you have decided on a CMSSW release, set up the work area:

cmsrel CMSSW_12_3_X_2022-02-11-1100
cd CMSSW_12_3_X_2022-02-11-1100/src
cmsenv

These commands clone a specific release of CMSSW, then activate the CMSSW environment, where the paths of most of the CMSSW tools are made available.

Initialize git area

git cms-init --upstream-only

Checkout a few packages using git cms-addpkg

Some useful packages for developing the pixel local reconstruction in CUDA:

CUDADataFormats/SiPixelCluster/
CUDADataFormats/SiPixelDigi/
RecoLocalTracker/SiPixelClusterizer/

You can add these packages with cms-addpkg:

(You need to be in the CMSSW_12_3_X_2022-02-11-1100/src repository)

git cms-addpkg CUDADataFormats/SiPixelCluster/
git cms-addpkg CUDADataFormats/SiPixelDigi/
git cms-addpkg DataFormats/SiPixelCluster/
git cms-addpkg DataFormats/SiPixelDigi/
git cms-addpkg RecoLocalTracker/SiPixelClusterizer/

See the checked out packages in .git/info/sparse-checkout

Output of cat .git/info/sparse-checkout 
/.clang-format
/.clang-tidy
/.gitignore
/CUDADataFormats/SiPixelCluster/
/CUDADataFormats/SiPixelDigi/
/RecoLocalTracker/SiPixelClusterizer/

Only build the desired packages, add/remove unwanted ones: http://cms-sw.github.io/git-cms-addpkg.html

Fetch updates from remote 

git checkout master
git fetch [official-cmssw]
git merge official-cmssw/master master

Where official-cmssw is the remote name configured for the CMSSW offline software repository.

You can list your remote repositories with (for even more verbose output, you can stack the -vs, e.g. -vvv):

git remote -v

Running checks on the code

scram b code-checks

Formatting the code

scram b code-format