Put all classes in Alieve/ sub-module out of the Alieve namespace and

[u/mrichter/AliRoot.git] / EVE / README

diff --git a/EVE/README b/EVE/README
index 9b88fb07d01768c5c3f75d83e7fa634f4d42d649..be723eb5d89af13cf2dbc38a56864e0c70c7c51a 100644 (file)
--- a/EVE/README
+++ b/EVE/README
@@ -7,8 +7,7 @@ EVE is composed of:
 3. CINT scripts that extract data, fill graphics classes and register
    them to the application.
 
-This is an early release ... expect problems and be sure that what you
-need is not supported.
+The framework is still evolving ... some things might not work as expected.
 
 
 Usage
@@ -28,9 +27,23 @@ Interactively:
    root[1] alieve_init("/somedir")
 
 3. Use GUI or CINT command-line to invoke further visualization macros.
-  
-See files in EVE/alice-macros/. For specific uses these should be
-edited to suit your needs.
+
+4. To navigate the events use macros 'event_next.C' and 'event_prev.C'.
+   These are equivalent to the command-line invocations:
+   root[x] Alieve::gEvent->NextEvent()
+or
+   root[x] Alieve::gEvent->PrevEvent()
+The general form to go to event via its number is:
+   root[x] Alieve::gEvent->GotoEvent(<event-number>)
+
+See files in EVE/alice-macros/ from the ROOT browser that is spawned
+automatically with the application. They can be executed directly from
+the browser (by dpouble-clicking on their icon) or via standard ROOT's
+macro execution methods using '.x' and '.L'. If you want to pass the
+arguments to the macros, use '.L' as this gives you automatic tab
+completion.
+
+For specific uses you can copy them and edit them to suit your needs.
 
 
 Directory structure
@@ -50,3 +63,32 @@ test-macros/      -- macros for tests of specific features; usually one needs
 
 bin/, Makefile and make_base.inc are used for stand-alone build of the
 packages.
+
+
+Examples
+========
+
+1. Run the interface for visual scanning:
+
+alieve -mode 2 trackcount_init.C
+
+
+Notes
+=====
+
+1. Problems with macro-execution
+--------------------------------
+
+A failed macro-execution can leave CINT in a poorly defined state that
+prevents further execution of macros. For example:
+
+  Exception Reve::Exc_t: Event::Open failed opening ALICE ESDfriend from
+  '/alice-data/coctail_10k/AliESDfriends.root'.
+
+  root [1] Error: Function MUON_geom() is not defined in current scope  :0:
+  *** Interpreter error recovered ***
+  Error: G__unloadfile() File "/tmp/MUON_geom.C" not loaded  :0:
+
+'gROOT->Reset()' helps in most of the cases.
+
+This has been fixed for most cases.