PAT Recipes & Development

Complete: 5

Development Branches

As software development is always faster than stable data taking, re-processing or large scale simulation suitable for physics analyses PAT is developed in Several Branches. While its development is rather stable for more settled releases dedicated checkout procedures are often required for more recent releases to guarantee:

  • The most up to date version tag of all relevant software packages.
  • The proper interplay of all relevant software packages.

Actual development branches and the supported tag conventions are shown below:

Branch Release PATCandidates PATAlgos PATUtils Comments
MAIN CMSSW_X_Y_Z V06-06-ZZ V08-11-ZZ   development branch for new framework
B6_1_X CMSSW_6_1_X V06-05-ZZ V08-10-34-ZZ   development branch for upgrade
B5_2_X CMSSW_5_3_X V06-05-06-ZZ V08-09-ZZ   production branch for 2012
B4_4_X CMSSW_4_4_X V06-04-ZZ V08-07-ZZ   production branch for 2011

Where the digits of the tags (VXX-YY-ZZ) have the following meaning:

  • Changes in the 3. digits (ZZ): bugfixes and minor changes.
  • Changes in the 2. digits (YY): changes of development branch (e.g. moving from CMSSW_5_3_X to CMSSW_6_1_X).
  • Changes in the 1. digits (XX): major structural changes, or changes which concern data formats changes.

For the latter there is no guarantee that you may still be able to run with the same input files (e.g. like patTuples produced with another version).

All other branches are considered as deprecated and will not be supported any more. Developers are asked whenever committing to backport branches to synchronise these changes with the cvs HEAD and to make sure that the system compiles and runs on a small set of test files.

Check-in Procedure

Please document any comits of code to one of the PAT packages on the appropriate Release Notes (see below). Major changes or structural changes should first be communicated to the responsible AT L2 (Volker). Please obey the following rules when committing code:

  • Include you changes in all relevant branches:
    • If a bugfix, the change should be on the appropriate release branch, as well as the HEAD
    • For major new developments, the change should be in the HEAD.
    • Subsequent to consultation, the development team may decide that the new development is a candidate for a back-port to one of the stable branches.
  • Compile against the latest PAT recipe.
  • Run the full set of unit tests in PhysicsTools/PatAlgos/test/runAsyncTests.pl --all
  • Estimate the timing impact (by turning on the wantSummary flag in your job): process.options = cms.untracked.PSet( wantSummary = cms.untracked.bool(True) )
  • Estimate the size impact (by running PhysicsTools/PatAlgos/test/diskSize.pl --all).
  • Tagged and queued your changes in the Tag Collector (if you don't have permissions, contact one of the members of the core development team).

Installation Recipes

PAT is part of all releases of the CMSSW_2_X_Y series and beyond. Unless stated otherwise you are always recommended to use PAT as it comes with the Most Actual Release for your analysis. Short instructions how to use the head version with the corresponding most actual release series are given below.

You can find more information about recent changes in the attached Release Notes in each corresponding section. For more details on changes in each package have a look into the CVS HN lists as linked to below:

CMSSW_6_2_X (dev2013)

TIPThis is the current development release cycle for the new CMSSW framework.

Important Notes:

This release cycle is under development. Please use the highest available release of this series.
For further information about the use of PAT have a look below.

For this release cycle we have fully switched to the unscheduled processing mode, which will simplify the use of tools enormously. Have a look this TWiki or the talks by Benedikt and by Roger to find out more about the implications of the unscheduled processing mode. For further information about the use of PAT have a look below:

User Information:

ALERT! All PAT Python tools have been adapted to the unscheduled processing mode %BR% Please make sure to have the corresponding

process.options.allowUnscheduled = cms.untracked.bool( True )
in your configuration file.

ALERT! The unscheduled processing mode is still under development for PFBRECO.

Development:

The CVS HEAD is only compatible with the CMSSW_6_2_Y release cycle.


See the corresponding Release Notes for details.

CMSSW_6_1_X (devUPGRADE)

TIPThis is the current development release cycle for upgrade.
ALERT!This release is closed for Analysis Tools development. Only bugfixes important for upgrade studies will be accepted.

Important Notes:

This release cycle is under development. Please use the highest available release of this series.
For further information about the use of PAT have a look below.

For this release cycle we have partially switched to the unscheduled processing mode, which will simplify the use of tools enormously. Have a look this TWiki or the talks by Benedikt and by Roger to find out more about the implications of the unscheduled processing mode. For further information about the use of PAT have a look below:

User Information:

ALERT! Almost all PAT Python tools have been adapted to the unscheduled processing mode %BR% Please make sure to have the corresponding

process.options.allowUnscheduled = cms.untracked.bool( True )
in your configuration file.

ALERT! The unscheduled processing mode is still under development for PFBRECO.

Development:

The CVS branch B6_1_X is fully compatible with CMSSW_6_1_X backports.
ALERT! Please note, that the CMSSW_6_0_X release cycle is depricated.


See the corresponding Release Notes for details.

CMSSW_5_3_X (pro2012)

TIPThis is the stable production release cycle for analysis users using 2012 data and MC.

Important Notes:

The currently recommended analysis release is CMSSW_5_3_11.
For further information about the use of PAT have a look below:

User Information:

Development:

The CVS branch B5_2_X is fully compatible with CMSSW_5_3_X backports.
ALERT! Please note, that the CMSSW_5_1_X release cycle is depricated.


See the corresponding Release Notes for details.

CMSSW_4_4_X (pro2011)

TIPThis is the stable production release cycle for analysis users using 2011 data and MC.

Important Notes:

The recommended analysis release is CMSSW_4_4_5.
For further information about the use of PAT have a look below:

User Information

Development:

The CVS branch B4_4_X is fully compatible with CMSSW_4_4_X backports.
ALERT! Please note, that the CMSSW_4_3_X release cycle is depricated.


See the corresponding Release Notes for details.

Compilation

All checkout procedures given above are confirmed to compile and to run with a predefined set of test sequences. For any deviation from the recipes given below there is no guarantee though that all software parts will work together without problems. To compile the packages you checked out do scram b -j 4 in your working directory.

Archive

Other releases then those shown above are not supported any more. Nevertheless you may find the old checkout procedures for the most important former releases in the SWGuidePATRecipesArchive.

Responsible: VolkerAdler

Topic attachments
I Attachment History Action Size Date Who Comment
Cascading Style Sheet filecss tutorial.css r1 manage 0.2 K 2010-11-16 - 00:20 RogerWolf  
Edit | Attach | Watch | Print version | History: r308 | r304 < r303 < r302 < r301 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r302 - 2013-06-19 - VolkerAdler
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    CMSPublic All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback