Merge branch 'cholmcc_generators_more' into cholmcc_aod_to_hepmc

Author: cholmcc

Generators/include/Generators/GeneratorFileOrCmdParam.h

@@ -36,7 +36,7 @@ struct GeneratorFileOrCmdParam : public o2::conf::ConfigurableParamHelper<Genera
   std::string bMaxSwitch = "-b";
   std::string nEventsSwitch = "-n";
   std::string backgroundSwitch = "&";
-  O2ParamDef(GeneratorFileOrCmdParam, "FileOrCmd");
+  O2ParamDef(GeneratorFileOrCmdParam, "GeneratorFileOrCmd");
 };
 
 } // end namespace eventgen

Generators/include/Generators/GeneratorHepMC.h

@@ -103,6 +103,7 @@ class GeneratorHepMC : public Generator, public GeneratorFileOrCmd
 
   /** HepMC interface **/
   uint64_t mEventsToSkip = 0;
+  int mVersion = 0;
   std::shared_ptr<HepMC3::Reader> mReader;
   /** Event structure */
   HepMC3::GenEvent* mEvent = nullptr;

Generators/src/GeneratorHepMC.cxx

@@ -74,14 +74,23 @@ void GeneratorHepMC::setup(const GeneratorFileOrCmdParam& param0,
                            const conf::SimConfig& config)
 {
   if (not param.fileName.empty()) {
-    LOG(fatal) << "The use of the key \"HepMC.fileName\" is "
-               << "no longer supported, use \"FileOrCmd.fileNames\" instead";
+    LOG(warn) << "The use of the key \"HepMC.fileName\" is "
+              << "deprecated, use \"GeneratorFileOrCmd.fileNames\" instead";
   }
-  if (param.version != 0)
-    LOG(warn) << "The key \"HepMC.version\" is no longer used. The "
-              << "version of the input files are automatically deduced.";
+
   GeneratorFileOrCmd::setup(param0, config);
+  if (not param.fileName.empty()) {
+    setFileNames(param.fileName);
+  }
+
+  mVersion = param.version;
   setEventsToSkip(param.eventsToSkip);
+
+  if (param.version != 0 and mCmd.empty()) {
+    LOG(warn) << "The key \"HepMC.version\" is no longer used when "
+              << "reading from files. The format version of the input files "
+              << "are automatically deduced.";
+  }
 }
 
 /*****************************************************************/
@@ -349,9 +358,14 @@ bool GeneratorHepMC::makeReader()
     // For FIFO reading, we assume straight ASCII output always.
     // Unfortunately, the HepMC3::deduce_reader `stat`s the filename
     // which isn't supported on a FIFO, so we have to use the reader
-    // directly.
+    // directly.  Here, we allow for version 2 formats if the user
+    // specifies that
     LOG(info) << "Creating ASCII reader of " << filename;
-    mReader.reset(new HepMC3::ReaderAscii(filename));
+    if (mVersion == 2) {
+      mReader.reset(new HepMC3::ReaderAsciiHepMC2(filename));
+    } else {
+      mReader.reset(new HepMC3::ReaderAscii(filename));
+    }
   } else {
     LOG(info) << "Deduce a reader of " << filename;
     mReader = HepMC3::deduce_reader(filename);

Generators/src/GeneratorPythia8.cxx

@@ -380,9 +380,10 @@ void GeneratorPythia8::getNpart(const Pythia8::Info& info, int& nPart)
 #else
   auto hiinfo = info.hiInfo;
 #endif
-  if (hiinfo)
+  if (hiinfo) {
     nPart = (hiinfo->nAbsProj() + hiinfo->nDiffProj() +
              hiinfo->nAbsTarg() + hiinfo->nDiffTarg());
+  }
 
   int nProtonProj, nNeutronProj, nProtonTarg, nNeutronTarg;
   getNpart(info, nProtonProj, nNeutronProj, nProtonTarg, nNeutronTarg);

run/CMakeLists.txt

@@ -279,7 +279,7 @@ o2_add_test_command(NAME o2sim_hepmc
                                       -g
                                    hepmc
                        --configKeyValues
-"FileOrCmd.fileNames=${CMAKE_SOURCE_DIR}/Generators/share/data/pythia.hepmc;HepMC.version=2;align-geom.mDetectors=none"
+"GeneratorFileOrCmd.fileNames=${CMAKE_SOURCE_DIR}/Generators/share/data/pythia.hepmc;HepMC.version=2;align-geom.mDetectors=none"
                                       -o
                               o2simhepmc
                     LABELS long sim hepmc3

run/SimExamples/HepMC/README.md

@@ -28,45 +28,46 @@ event files in the HepMC format.
 
 To make a simulation reading from the file `events.hepmc`, do
 
-    o2-sim -g hepmc --configKeyValues "FileOrCmd.fileNames=events.hepmc" ...
+    o2-sim -g hepmc --configKeyValues "GeneratorFileOrCmd.fileNames=events.hepmc" ...
 
 See also [`read.sh`](read.sh).
 
 ## 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
 
-    o2-sim -g hepmc --configKeyValues "FileOrCmd.cmd=eg"
+    o2-sim -g hepmc --configKeyValues "GeneratorFileOrCmd.cmd=eg"
 
 See also [`child.sh`](child.sh).
 
 There are some requirements on the program `eg`:
 
 - The EG program _must_ be able to write the HepMC event structures to
   a specified file.  The option passed to the program is specified via
-  the key `FileOrCmd.outputSwitch`.  This defaults to `>` which means
-  the EG program is assumed to write the HepMC event structures to
-  standard output, _and_ that nothing else is printed on standard
-  output.
+  the key `GeneratorFileOrCmd.outputSwitch`.  This defaults to `>`
+  which means the EG program is assumed to write the HepMC event
+  structures to standard output, _and_ that nothing else is printed on
+  standard output.
 - It _must_ accept an option to set the number of events to generate.
   This is controlled by the configuration key
-  `FileOrCmd.nEventsSwitch` and defaults to `-n`.  Thus, the EG
-  application should accept `-n 10` to mean that it should generate
+  `GeneratorFileOrCmd.nEventsSwitch` and defaults to `-n`.  Thus, the
+  EG application should accept `-n 10` to mean that it should generate
   `10` events, for example.
 - The EG application should accept a command line switch to set the
-  random number generator seed.   This option is specified via the
-  configuration key `FileOrCmd.seedSwitch` and defaults to `-s`.
-  Thus, the EG application must accept `-s 123456` to mean to set the
-  random number seed to `123456` for example.
+  random number generator seed.  This option is specified via the
+  configuration key `GeneratorFileOrCmd.seedSwitch` and defaults to
+  `-s`.  Thus, the EG application must accept `-s 123456` to mean to
+  set the random number seed to `123456` for example.
 - The EG application should accept a command line switch to set the
   maximum impact parameter (in Fermi-metre) sampled.  This is set via
-  the configuration key `FileOrCmd.bMaxSwithc` and defaults to `-b`.
-  Thus, the EG application should take the command line argument `-b
-  10` to mean that it should only generate events with an impact
-  parameter between 0fm and 10fm.
+  the configuration key `GeneratorFileOrCmd.bMaxSwithc` and defaults
+  to `-b`.  Thus, the EG application should take the command line
+  argument `-b 10` to mean that it should only generate events with an
+  impact parameter between 0fm and 10fm.
 
 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
@@ -76,8 +77,8 @@ We can filter that out via a shell script ([`crmc.sh`](crmc.sh)) like
     #!/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
-of single characters `E` (event), `A` (attribute), `U` (units), `W`
+The `sed` command selects lines that begin with `HepMC::`, or one of
+single characters `E` (event), `A` (attribute), `U` (units), `W`
 (weight), `V` (vertex), or `P` (particle) followed by a space.  This
 should in most cases be enough to filter out extra stuff written on
 standard output.
@@ -87,7 +88,7 @@ The script above also passes any additional command line options on to
 the CRMC suite.  For example, if we want to simulate p-Pb collisions
 using DpmJET, we can do
 
-    o2-sim -g hepmc --configKeyValues "FileOrCmd.cmd=crmc.sh -m 12 -i2212 -I 1002080820"
+    o2-sim -g hepmc --configKeyValues "GeneratorFileOrCmd.cmd=crmc.sh -m 12 -i2212 -I 1002080820"
 
 
 ### Implementation details
@@ -109,46 +110,50 @@ The `GeneratorHepMC` (and sister generator `GeneratorTParticle`)
 allows customisation of the execution via configuration keys passed
 via `--configKeyValues`
 
-- `HepMC.eventsToSkip=number` a number events to skip at the
-  beginning of each file read.
+- `HepMC.eventsToSkip=number` a number events to skip at the beginning
+  of each file read.
+
+- `HepMC.version` - when reading the events from files, this option is
+   no longer needed.  The code itself figures out which format version
+   the input file is in. If executing a child process through
+   `GeneratorFileOrCmd.cmd` and the EG writes out HepMC2 format, then
+   this _must_ be set to `2`. Otherwise, HepMC3 is assumed.
 
-- `FileOrCmd.fileNames=list` a comma separated list of HepMC files
-  to read.
+- `GeneratorFileOrCmd.fileNames=list` a comma separated list of HepMC
+  files to read.
 
-- `FileOrCmd.cmd=command line` a command line to execute as a
+- `GeneratorFileOrCmd.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.
+  then `GeneratorFileOrCmd.fileNames` is ignored.
 
-- A number of keys that specifies the command line option switch
-  that the child program accepts for certain things.  If any of
-  these are set to the empty string, then that switch and
-  corresponding option value is not passed to the child program.
+- A number of keys that specifies the command line option switch that
+  the child program accepts for certain things.  If any of these are
+  set to the empty string, then that switch and corresponding option
+  value is not passed to the child program.
 
-  - `FileOrCmd.outputSwitch=switch` (default `>`) to specify output
-    file.  The default of `>` assumes that the program write HepMC
-    events, and _only_ those, to standard output.
+  - `GeneratorFileOrCmd.outputSwitch=switch` (default `>`) to specify
+    output file.  The default of `>` assumes that the program write
+    HepMC events, and _only_ those, to standard output.
 
-  - `FileOrCmd.seedSwitch=switch` (default `-s`) to specify the
-    random number generator seed. The value passed is selected by
+  - `GeneratorFileOrCmd.seedSwitch=switch` (default `-s`) to specify
+    the random number generator seed. The value passed is selected by
     the `o2-sim` option `--seed`
 
-  - `FileOrCmd.bMaxSwitch=switch` (default `-b`) to specify the
-     upper limit on the impact parameters sampled.  The value passed
-     is selected by the `o2-sim` option `--bMax`
+  - `GeneratorFileOrCmd.bMaxSwitch=switch` (default `-b`) to specify
+     the upper limit on the impact parameters sampled.  The value
+     passed is selected by the `o2-sim` option `--bMax`
 
-  - `FileOrCmd.nEventsSwitch=switch` (default `-n`) to specify the
-     number of events to generate.  The value passed is selected by
-     the `o2-sim` option `--nEvents` or (`-n`)
+  - `GeneratorFileOrCmd.nEventsSwitch=switch` (default `-n`) to
+     specify the number of events to generate.  The value passed is
+     selected by the `o2-sim` option `--nEvents` or (`-n`)
 
-  - `FileOrCmd.backgroundSwitch=switch` (default `&`) to specify how
-    the program is put in the background.  Typically this should be
-    `&`, but a program may itself fork to the background.
+  - `GeneratorFileOrCmd.backgroundSwitch=switch` (default `&`) to
+    specify how 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 deprecated
 
-  - `HepMC.fileName` - use `FileOrCmd.fileNames`
-  - `HepMC.version` - now the code itself figures out which format
-    version the input file is in.
+  - `HepMC.fileName` - use `GeneratorFileOrCmd.fileNames`
 
 The command line build will now be
 

run/SimExamples/HepMC/child.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 
 cmd="./crmc.sh"
+more="GeneratorFileOrCmd.bMaxSwitch=none"
 seed=$RANDOM
 nev=1
 out=
@@ -13,6 +14,7 @@ Usage: $0 [OPTIONS]
 Options:
 
   -c,--cmdline COMMAND     Command line
+  -m,--more    CONFIG      More configurations ($more)
   -s,--seed    SEED        Random number seed ($seed)
   -n,--nevents EVENTS      Number of events ($nev)
   -o,--output  OUTPUT      Output prefix ($out)
@@ -47,5 +49,5 @@ fi
 out=`echo "$out" | tr ' ' '_'`
 
 export VMCWORKDIR=${O2_ROOT}/share
-o2-sim -g hepmc --configKeyValues "FileOrCmd.cmd=$cmd" \
+o2-sim -g hepmc --configKeyValues "GeneratorFileOrCmd.cmd=$cmd;${more}" \
        --outPrefix "$out" --seed $seed --nEvents $nev $@

run/SimExamples/HepMC/crmc.sh

@@ -3,5 +3,5 @@
 # event record.
 
 crmcParam=$(dirname $(dirname `which crmc`))/etc/crmc.param
-exec crmc -c $crmcParam $@ -o hepmc3 -f /dev/stdout | \
+exec crmc -c $crmcParam $@ -o hepmc -f /dev/stdout | \
     sed -n 's/^\(HepMC::\|[EAUWVP] \)/\1/p'

run/SimExamples/HepMC/read.sh

@@ -44,5 +44,5 @@ fi
 out=`echo "$out" | tr ' ' '_'`
 
 export VMCWORKDIR=${O2_ROOT}/share
-o2-sim -g hepmc --configKeyValues "FileOrCmd.fileNames=$inp" \
+o2-sim -g hepmc --configKeyValues "GeneratorFileOrCmd.fileNames=$inp" \
        --outPrefix "$out" --seed $seed --nEvents $nev $@

run/SimExamples/HepMC_STARlight/run.sh

@@ -15,4 +15,4 @@ env -i HOME="$HOME" USER="$USER" PATH="/bin:/usr/bin:/usr/local/bin" \
 # PART b)
 NEV=1000
 o2-sim -j 20 -n ${NEV} -g hepmc -m PIPE ITS -o sim \
-       --configKeyValues "FileOrCmd.fileNames=starlight.hepmc;Diamond.position[2]=0.1;Diamond.width[2]=0.05"
+       --configKeyValues "GeneratorFileOrCmd.fileNames=starlight.hepmc;Diamond.position[2]=0.1;Diamond.width[2]=0.05"