ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/CMSSW/PhysicsTools/PythonAnalysis/doc/PythonAnalysis.doc
Revision: 1.3
Committed: Wed Mar 22 13:51:20 2006 UTC (19 years, 1 month ago) by hegner
Content type: application/msword
Branch: MAIN
Changes since 1.2: +9 -4 lines
Log Message:
added explanation for new modules

File Contents

# User Rev Content
1 hegner 1.1 /*!
2    
3 llista 1.2 \page PhysicsTools_PythonAnalysis Package PhysicsTools/PythonAnalysis
4 hegner 1.1 <center>
5     <small>
6 llista 1.2 <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/PhysicsTools/PythonAnalysis/?cvsroot=CMSSW>CVS head for this package</a> -
7     <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/PhysicsTools/PythonAnalysis/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
8 hegner 1.1 </small>
9     </center>
10    
11     \section desc Description
12     <!-- Short description of what this package is supposed to provide -->
13 hegner 1.3 Examples of using CMSSW in Python.
14     Some helper routines for startup, tab completion and shorter syntax.
15    
16 hegner 1.1
17     \subsection interface Public interface
18 hegner 1.3 - <b>cmstools</>: public interface to all modules. Do <tt>export PYTHONPATH=$CMSSW_BASE/src/PhysicsTools/PythonAnalysis/python:$PYTHONPATH</tt> to
19     use it.
20 hegner 1.1
21     \subsection modules Modules
22 hegner 1.3 - <b>cmstools.py</b>: prepares environment and defines some commands
23     - <b>cmscompleter.py</b>: class for tab completion
24     - <b>namespaceDict.py</b>: builds the FWLite namespace (without loading libs)
25 hegner 1.1
26     \subsection tests Unit tests and examples
27 llista 1.2 - <b>trackerHits.py</b>: Reads sim event information and creates the files <tt>histo.root</tt>
28     and <tt>tofhits.jpg</tt>.
29     - <b>howto.txt</b>: short explanation
30 hegner 1.1
31     \section status Status and planned development
32     <!-- e.g. completed, stable, missing features -->
33     Prototype.
34    
35     <hr>
36 hegner 1.3 Last updated: 22-MAR-2006 B. Hegner
37 hegner 1.1 */
38