Changeset 13325 for fact/tools/pyscripts/doc

Timestamp:

04/07/12 10:10:13 (13 years ago)

Author:

neise

Message:

removed doubled classes content and added some examples

File:

• fact/tools/pyscripts/doc/getting_started.rst (modified) (3 diffs)

fact/tools/pyscripts/doc/getting_started.rst

@@ -27 +27 @@
 
 2. Environment variables
-=====================
+========================
 set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc
 
@@ -43 +43 @@
 
 3. Check out the repository
-========================
+===========================
 svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/
 
 4. Create pyfits_h.so library
-========================
+=============================
 FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools: 
 
@@ -82 +82 @@
 
 5. Run examples
-============
+===============
 
+*datafilepath* and *calibfilepath* should be adjusted in case you are not working
+on the ISDC cluster. 
 
-=======
-Classes
-=======
+explore class RawData::
 
-pyfact.py
-=========
+  import pyfact
+  datafilepath = '/data00/fact-construction/raw/2012/03/04/20120304_018.fits.gz'
+  calibfilepath = '/data00/fact-construction/raw/2012/03/04/20120304_012.drs.fits.gz'
+  run = pyfact.RawData( datafilepath, calibfilepath, return_dict = True)
+  event = run.next()
+  
+  type(event)
+  
+  print 70*'*'
+  for key in event:
+    print 'key  :', key
+    print 'value:', event[key]
+    print 70*'*'
 
-rawdata access
--------
-.. autoclass:: pyfact.RawData
-    :members:
+loop over RawData::
 
-
-fnames of a data run
---------------------
-.. autoclass:: pyfact.fnames
-        :members:
-
+  import pyfact
+  datafilepath = '/data00/fact-construction/raw/2012/03/04/20120304_018.fits.gz'
+  calibfilepath = '/data00/fact-construction/raw/2012/03/04/20120304_012.drs.fits.gz'
+  run = pyfact.RawData( datafilepath, calibfilepath, return_dict = True)
+  
+  for event in run:
+    print 'event_id:', event['event_id'] 
+    # the data can be found in event['acal_data']
 
 .. rubric:: Footnotes