WorkBook Print Review Page

Complete:

Goals of this page: How to use this page Print Review Table ESSENTIALS ADVANCED TOPICS Roles and Responsibilities Workbook editor Responsible person Content expert: End-user reviewer:

Newsbox 21 Jan 09: Call for end-user reviewres 16 Dec 09: Assigning expert reviewers 25 Nov 09: The reviewed pages have the status updated in the Status column 25 Nov 09: All page responsibles (apart HLT) confirmed that they can review the page by Nov 27 04 Nov 09: The next print review will take page in November/December 09. The WorkBook must be completely updated and reviewed prior to the printing.

Goals of this page:

The purpose of this page is to keep track of the updates needed prior to a scheduled printing of the WorkBook.

How to use this page

• This page is for book-keeping of progress for each review, it will be emptied before a new review.
• For the final (expert) review, reply to my mail that you agree to review the page and let me know when done.
• For the end-user review, the reviewers can ask new-comers to the topic(s) to read through the page.
  • the reviewer should add the name of the "end-user reviewer" to the corresponding column.

Print Review Table

ESSENTIALS

Section	Responsible	Status	Comments	Expert review	End-user review
Preface
Acknowledgements	Kati Lassila-Perini		Done 12 Nov
Using the Workbook	Kati Lassila-Perini		Done 12 Nov
Overview of CMS Physics Goals and Detector	Kati Lassila-Perini		Done 12 Nov
Maintenance
Information for Contributors	Kati Lassila-Perini		Done 25 Nov
Glossary/Index	Kati Lassila-Perini
CMSsandbox.ToDo	Kati Lassila-Perini
Section	Responsible	Status	Comments	Expert review	End-user review
Chapter 1: Accounts and Registration
Introduction	Kati Lassila-Perini		Done 12 Nov
Getting a Computing Account	CMS User Support		Done 12 Nov	Martti Pimiä tbc
Setting up your Computing Environment	Kati Lassila-Perini		Done 11 Dec	Andreas Pfeiffer Done
CMS Computing Concepts: Programming, CVS, etc	Sudhir Malik (confirmed Nov 11)		SM Done	Andreas Pfeiffer Done
Where to get help	Kati Lassila-Perini
On your First Visit to CERN	Kati Lassila-Perini		Done 25 Nov	Kirsti Aspola tbc
Chapter 2: The Basics of CMS Offline Computing
Introduction	Kati Lassila-Perini		Done 25 Nov
The CMS Computing Model	Tony Wildish (confirmed Nov 12)		Done 12 Nov TW: 25 T2s in figures	Ian Fisk tbc
The CMSSW Application Framework	Kati Lassila-Perini			Liz Kennedy tbc
Section	Responsible	Status	Comments	Expert review	End-user review
Chapter 3: Getting Started with Data Analysis
Analysis Overview: an Introduction	Petar Maksimovic			Benedikt Hegner	Charles Maguire
Which Release to use	Kati Lassila-Perini		Done 25 Nov	Andreas Pfeiffer Done	Charles Maguire
Finding Data	Kati Lassila-Perini			Benedikt Hegner	Charles Maguire
EDM Tools	Petar Maksimovic			Benedikt Hegner	Charles Maguire
Fireworks	Dmytro Kovalskyi (confirmed Nov 11)				Charles Maguire
Fireworks tutorial	Dmytro Kovalskyi (confirmed Nov 11)				Charles Maguire
Getting Started with FW Lite	Petar Maksimovic			Benedikt Hegner	Charles Maguire
Event Loop in FW Lite	Petar Maksimovic			Benedikt Hegner	Charles Maguire
Examples of FW Lite Macros	Petar Maksimovic			Benedikt Hegner	Charles Maguire
FW Lite in Python (PyROOT)	Petar Maksimovic			Benedikt Hegner	Charles Maguire
FWLite Executables	Charles Plager (confirmed Nov 11)		Sal Done	Benedikt Hegner	Charles Maguire
not included:
Data Formats and Data Tiers	Benedikt Hegner		KLP: to be removed? included in intro
Different Ways to Make an Analysis	Benedikt Hegner		KLP: to be removed? Links to it to be updated
Chapter 4: CMSSW Framework in Data Analysis
Data Analysis in the Full Framework	Petar Maksimovic			Benedikt Hegner	Eric Appelt
More on CMSSW Framework	Sudhir Malik (confirmed Nov 11)		SM:Done	Benedikt Hegner	Eric Appelt
Analysis Code Example	Sudhir Malik (confirmed Nov 11)		SM: Done	Benedikt Hegner	Eric Appelt
Introduction to CMS ConfigFiles	Rick Wilkinson (confirmed Nov 12)		RW: Done 9 Dec	Benedikt Hegner	Eric Appelt
Config Editor	Andreas Hinzmann (confirmed 12 Nov)		Done 12. Nov	Benedikt Hegner	Eric Appelt
Physics Analysis Toolkit (PAT) Tutorial	Roger Wolf (confirmed 11 Nov)		Done 31. Nov	Benedikt Hegner	Ben Snook
PAT Examples	Roger Wolf		Done 26. Nov	Benedikt Hegner	Ben Snook
PAT Examples: basic example	Roger Wolf		Done 26.Nov	Benedikt Hegner	Ben Snook
PAT Examples: FWLite example	Roger Wolf		Done 26. Nov	Benedikt Hegner	Ben Snook
PAT DataFormats	Roger Wolf (confirmed 11 Nov)		KLP: renamed, Done 26. Nov, TOC still needs to be replaced	Benedikt Hegner	Ben Snook
PAT Workflow	Roger Wolf (confirmed 11 Nov)		KLP: renamed, Done 31. Nov, TOC still needs to be replaced	Benedikt Hegner	Ben Snook
Candidate Utilities	Luca Lista			Benedikt Hegner tbc	Eric Appelt
Generated Particle Cands	Luca Lista			Benedikt Hegner tbc	Ben Snook
MC Truth Matching	Luca Lista			Benedikt Hegner tbc	Ben Snook
High Level Trigger Tutorial	Pedrame Bargassa				Eric Appelt
Trigger information in PAT	Volker Adler		VA: Done 18 Jan		Eric Appelt
The CMS Event Display	Yana Osborne (confirmed Nov 12)		Done 18 Dec
not included:
Particle Candidates	Luca Lista
Analysis Starter Kit	Salvatore Rappoccio		KLP: to be removed? SR: decommisioned, can be removed
Section	Responsible	Status	Comments	Expert review	End-user review
Chapter 5: Using the Computing Resources
Chapter Overview -- Getting started	fkw		fkw: Done Dec.6th	Stefano Belforte
Grid Computing Context	fkw		fkw: Done Dec. 6th	Stefano Belforte
Analysis Work Flow on the Grid	fkw		fkw: Done Dec.6th	Stefano Belforte
Locating Data Samples	fkw		fkw: Done Dec.6th	Stefano Belforte
Data Analysis with CRAB	Dave L. Evans		DLE: Done Dec. 11th	Stefano Belforte
Job Monitoring with CMS Dashboard	Julia Andreeva (confirmed Nov 12)		JA: Done 30 Nov	Stefano Belforte
Using T2 Resources	Thomas Kress (confirmed Nov 12)		TK: Done 27 Nov	Frank Wuerthwein
Transferring Data Files	Simon Metson			Frank Wuerthwein
Data Organization Explained	fkw		fkw: Done Dec. 6th	Simon Metson
Running a Grid Job using CRAB	Federica Fanzago (confirmed Nov 12)		FF: Done 9 Dec	Dave Evans
CRAB at CAF/LSF at CERN	Marco Calloni (confirmed Nov 12)		MC: Done 25 Nov KLP: to be removed from the wb index or to be renamed	Dave Evans
Grid Job Diagnosis Template	Marco Calloni (confirmed Nov 12)		MC: Done 25 Nov	Dave Evans
Appendices
Remote Institution/Site Specific Information	Sudhir Malik (confirmed Nov 11)		SM: Done
Troubleshooting Guide	Sudhir Malik (confirmed Nov 11)		SM: Done
Basic Linux Commands	Kati Lassila-Perini		Done 25 Nov
ROOT Basics	Kati Lassila-Perini
Introduction to SCRAMV1	Shahzad Muzaffar (confirmed Nov 17)		SM: Done 30 Nov	Andreas Pfeiffer Done
About BuildFiles	Shahzad Muzaffar (confirmed Nov 17)		SM: Done 30 Nov	Andreas Pfeiffer Done
Declaring Modules to SEAL	Chris Jones		moved to SWGuide

ADVANCED TOPICS

Section	Responsible	Status	Comments	Expert review	End-user review
Chapter 6: Event Generation and Simulation
Thirty Second Introduction	Julia Yarba (confirmed Nov 11)		JY Done 1 Dec	Sunanda Banerjee tbc
Generating Monte Carlo events	Julia Yarba (confirmed Nov 11)		JY Done 4 Dec	Fabio Cossutti Done
How to Produce simu+digi Data from Generated Events	Julia Yarba (confirmed Nov 11)		JY Done 4 Dec, missing subsection on storing/restoring random seeds and reproducing simulated events	Mike Hilderith Done
Standard reconstruction	Jean-Roch Vlimant		new to this chapter
Fast Simulation	Salavat Abdoulline (confirmed 11 Nov)		SA Done 1 Dec	Andrea Perrotta Done 12 Dec 09
Chapter 7: Higher-Level Object Analysis Tutorials
Introduction to Higher-Level Object Analysis Tutorials	Kati Lassila-Perini		Done
Track Reconstruction	Giuseppe Cerati (confirmed Nov 12)		GC: Done 27 Nov	Kevin Burkett tbc
PAT Examples: Tracking, Vertexing and b-Tagging	Armin Scheurer; Christophe Saout tbc		AS Done 13 Jan		Jyothsna Rani KOMARAGIRI
Vertex Reconstruction	Thomas Speer (confirmed Nov 13)		Done Dec 18
WorkBookOfflinePrimaryVertexFinding	Thomas Speer (confirmed Nov 13)		Done Dec 18
WorkBookVertexFittingTutorial	Thomas Speer (confirmed Nov 13)		Done Dec 18
Electron Analysis	David Chamont (confirmed Nov 11)		DC Done 1 Dec	Marco Pieri Done
PAT Examples: Electron Example	Roger Wolf tbc
Photon Analysis	Nancy Marinelli (confirmed Nov 25)		NM Done 26 Nov	Marco ri Done
Jet Reconstruction	Hartmut Stadie (confirmed Nov 13)			Robert Harris Done	Ilya Osipenkov Done
MET Analysis	Frank Golf (confirmed Nov 20)		FG: Done 27 Nov	Robert Harris Done	Jae Hyeok Done
Muon Reconstruction	Dmytro Kovalskyi (confirmed Nov 11)		Done	Slava Valuev tbc
PAT Examples: Muon Example	Riccardo Bellan tbc
B Tagging	Cecilia Gerber (confirmed Nov 13)		Tommaso Boccali Done 15 Dec	Andrea Rizzi tbc	Jyothsna Rani KOMARAGIRI
PF Tau Tagging	Simone Gennai (looking for responsible)
PAT Examples: Tau Example	Christian Veelken		CV Done 18 Dec 09
Particle flow tutorial	Colin Bernet (confirmed Nov 11)		CB: Up-to-date
Section	Responsible	Status	Comments	Expert review	End-user review
Chapter n: Physics Analysis Group Examples
CMS.BPhysicsPAT	Keith Ulmer		KU: Done 29 Dec
WorkBookPATExampleElectroweak	Francesco Fabozzi		FF: Done 18 Jan
WorkBookPATExampleExotica	Kai-Feng Chen
WorkBookPATExampleHiggs	Nicola de Filippis
WorkBookPATExampleQCD	Vasu Chetluru
WorkBookPATExampleTopQuarks	Sebastian Naumann		SN: Done 10 Dec
Section	Responsible	Status	Comments	Expert review	End-user review
Chapter 9: Advanced Tools and Tasks
Introduction to Advanced Tools and Tasks	Kati Lassila-Perini
Common EDM Utilities	Rick Wilkinson (confirmed Nov 12)		Done	Liz Kennedy tbc
Common Containers for EDM Objects	Luca Lista		LL: Done 27 Nov (static content)
Own Vector Container	Luca Lista		LL: Done 27 Nov (static content)
Association Map Container	Luca Lista		LL: Done 27 Nov (static content)
Association Vector Container	Luca Lista		LL: Done 27 Nov (static content)
Some common data types in CMSSW	Tim Cox Done 11 Nov		OK for LocalPoint, GlobalPoint and friends. Asked Ian Tomalin for the rest. Done 11 Nov	Liz Kennedy tbc
Adding information to the event with the EDProducer	Sudhir Malik (confirmed Nov 11)		SM: Done
Navigating the Detector Geometry	Michael Case		KLP: moved to SWGuide
Application of Alignment and Calibration Constants	David Futyan (confirmed 11 Nov)		DF: moved to SWGuide
Chapter 10: Other Topics
Software Infrastructure
Installing CMS Software	Kati Lassila-Perini		Done 14 Dec	Andreas Pfeiffer Done
Developing Software	Sudhir Malik (confirmed Nov 11)		SM Done	Andreas Pfeiffer Done, from the old review:Andreas Pfeiffer: (12 Feb) links to examples on how to develop and how to run on test samples to be added
Optimizing Your Code	Peter Elmer (confirmed Nov 25)
Common Performance Issues	Peter Elmer (confirmed Nov 25)

Roles and Responsibilities

Workbook editor

The Workbook editor coordinates Workbook effort, works with responsible persons, content experts and end-user reviewers to review/update Workbook topic pages as necessary. Specific tasks:

• Adds any new page to the appropriate table in the "print review" page, sets completeness bar to match the setting in page.
• Designates content experts to review any new pages and any significantly changed pages.
• Designates end-user reviewer from the list of available reviewers to review new or changed page for usefulness, and readability.
• Monitors workbook and print review page.

Responsible person

The "responsible person" for a Workbook page is expected to keep the page updated such that correct information and instructions are always provided. Specific tasks:

For new page:

• Adds new page according to contributor guidelines, adds content, and in the case of a tutorial, verifies that the instructions work.
• Notifies Workbook HN forum when page is drafted and ready for expert review.
• Updates page according to reviewer comments; either content expert or responsible person can make the updates..

In general:

• Checks his/her tutorial pages whenever a new CMSSW release has come out, and on "as needed" basis.
• Notifies the Workbook HN forum after making any substantive changes to page.
• Makes sure completeness indicators on topic page and on print review page are always set correctly.
• Indicates in the newsbox of the page whenever the page is ready for expert review.

Content expert:

The content expert is responsible for communicating new content to the responsible person and for review prior to each printing. These persons should be the persons in charge of services described in the page, or leaders of the different activities in computing, software or physics areas covered by the subject, or persons they wish to nominate. The reconstruction tutorials should be reviewed by the leaders of the corresponding group or activities. The content experts are designated by the Workbook editor according to the page subject. Specific tasks:

• Reviews new or existing page when notified by Workbook editor and on "as needed" basis.
• Verifies that topic is covered adequately and accurately.
• Notifies responsible person to edit page as necessary; either content expert or responsible person can make the updates.
• Noitifies the WorkBOok editor when the page is ready for print.

End-user reviewer:

These will be users chosen both from CERN and off-site. The reviewer is to be a non-expert in the topic being reviewed. The expert reviewers of each topic should designate an end-user reviewer for each topic. One topic can have more than one end-user reviewers.. Specific tasks:

• Reviews and sends comments to responsible person or Workbook HN forum.
• Puts name and date in the "end-user review" column in the "print review" page.

---

Responsible: SudhirMalik