Merge branch 'cholmcc_generatos' into cholmcc_generators_more

Author: cholmcc

run/SimExamples/HepMC/README.md

@@ -5,36 +5,33 @@
 Here are pointers on how to use `GeneratorHepMC` selected by the
 option `-g hepmc` for `o2-sim`. 
 
-## Reading HepMC files 
+## Reading HepMC files
 
 The generator `GeneratorHepMC` can read events from a
-[HepMC(3)](http://hepmc.web.cern.ch/hepmc/) formatted file.  These files
-can be produced by a standalone event generator program (EG).
-Examples of such programs are 
+[HepMC(3)](http://hepmc.web.cern.ch/hepmc/) formatted file.  These
+files can be produced by a standalone event generator program (EG).
+Examples of such programs are
 
 - [Pythia8](https://pythia.org)
-- The [CRMC](https://gitlab.iap.kit.edu/AirShowerPhysics/crmc) suite 
+- The [CRMC](https://gitlab.iap.kit.edu/AirShowerPhysics/crmc) suite
 - [Herwig](https://herwig.hepforge.org/)
 - [SMASH](https://smash-transport.github.io/)
-- ... and many others 
+- ... and many others
 
 Please refer to the documentation of these for more on how to make
 event files in the HepMC format. 
 
-To make a simulation reading from the file `events.hepmc`, do 
-
+To make a simulation reading from the file `events.hepmc`, do
     o2-sim -g hepmc --configKeyValues "HepMC.fileName=events.hepmc"	...
 
 See also [`read.sh`](read.sh) 
 
-## Reading HepMC events from child process 
-
+## Reading HepMC events from child process
 `GeneratorHepMC` can not only read HepMC events from a file, but can
 also spawn an child EG to produce events.  Suppose we have a program
 named `eg` which is some EG that writes HepMC event records to the
 standard output.  Then we can execute a simulation using this external
-EG by 
-
+EG by
     o2-sim -g hepmc --configKeyValues "HepMC.progCmd=eg" 
 
 See also [`child.sh`](child.sh) 
@@ -50,10 +47,9 @@ There are some requirements on the program `eg`:
 If a program does not adhere to these requirements, it will often be
 simple enough to make a small wrapper script that enforce this.  For
 example, `crmc` will write a lot of information to standard output.
-We can filter that out via a shell script ([`crmc.sh`](crmc.sh)) like 
+We can filter that out via a shell script ([`crmc.sh`](crmc.sh)) like
 
-    #!/bin/sh 
-	
+    #!/bin/sh
 	crmc $@ -o hepmc3 -f /dev/stdout | sed -n 's/^\(HepMC::\|[EAUWVP] \)/\1/p'
 
 The `sed` command selects lines that begin with `HepMC::`, or one
@@ -65,12 +61,12 @@ standard output.
 The script above also passes any additional command line options on to
 `crmc` via `$@`.  We can utilise this with `o2-sim` to set options to
 the CRMC suite.  For example, if we want to simulate p-Pb collisions
-using DpmJET, we can do 
+using DpmJET, we can do
 
     o2-sim -g hepmc --configKeyValues "HepMC.progCmd=crmc.sh -m 12 -i2212 -I 1002080820"
 
 
-### Implementation details 
+### Implementation details
 
 Internally `GeneratorHepMC` 
 
@@ -81,14 +77,14 @@ Internally `GeneratorHepMC`
 
       eg options > fifo-name & 
 
-4. and executes that command line 
+4. and executes that command line
 
-## The future 
+## The future
 
 The `GeneratorHepMC` (and sister generator `GeneratorTParticle`) will
 in the not so distant future be upgraded with new functionality to
 more easily customise reading files and executing a child process.  In
-particular 
+particular
 
 - HepMC event structures can be read from any file format supported by
   HepMC it self (see
@@ -101,8 +97,7 @@ particular
     beginning of each file read. 
 
   - `FileOrCmd.fileNames=list` a comma separated list of HepMC files
-    to read 
-	
+    to read
   - `FileOrCmd.cmd=command line` a command line to execute as a
     background child process.  If this is set (not the empty string),
     then `FileOrCmd.fileNames` is ignored. 
@@ -132,19 +127,18 @@ particular
       the program is put in the background.  Typically this should be
       `&`, but a program may itself fork to the background.
 
-- Some options are no longer available 
-
+- Some options are no longer available
   - `HepMC.fileName` - use `FileOrCmd.fileNames`
   - `HepMC.progCmd` - use `FileOrCmd.cmd` 
 
-The command line build will now be 
+The command line build will now be
 
 > _commandLine_ _nEventsSwitch_ _nEvents_ _seedSwitch_ _seed_
 > _bMaxSwitch_ _bMax_ _outputSwitch_ _output_ _backgroundSwitch_
 
 If any of the `Switch` keys are empty, then the corresponding option
 is not propagated to the command line.  For example, if _bMaxSwitch_
-is empty, then the build command line will be 
+is empty, then the build command line will be
 
 > _commandLine_ _nEventsSwitch_ _nEvents_ _seedSwitch_ _seed_
 > _outputSwitch_ _output_ _backgroundSwitch_

run/SimExamples/TParticle/MyEG.cc run/SimExamples/TParticle/MyEG.macrorun/SimExamples/TParticle/MyEG.cc renamed to run/SimExamples/TParticle/MyEG.macro

@@ -131,7 +131,7 @@ and a steering class
 	  }
 	};
 
-Then we could make the script [`MyEG.cc` (complete code)](MyEG.cc) like
+Then we could make the script [`MyEG.macro` (complete code)](MyEG.macro) like
 
     void MyEG(Int_t nev,const TString& out,Int_t every=1)
     {
@@ -143,7 +143,7 @@ Then we could make the script [`MyEG.cc` (complete code)](MyEG.cc) like
     }
 
 and a simple shell-script [`myeg.sh`](myeg.sh) to pass arguments to
-the `MyEG.cc` script
+the `MyEG.macro` script
 
     #!/bin/sh
 
@@ -159,7 +159,7 @@ the `MyEG.cc` script
         shift
     done
 
-    root -l MyEG.cc -- $nev \"$out\"
+    root -l MyEG.macro -- $nev \"$out\"
 
 We can then do 
 

run/SimExamples/TParticle/README.md

@@ -18,5 +18,5 @@ while test $# -gt 0 ; do
     shift
 done
 
-root -q -l MyEG.cc${opt} -- $nev \"$out\" $seed
+root -q -l MyEG.macro${opt} -- $nev \"$out\" $seed