[O2-621] Rename executables from run/ directory.

aphecetche · ktf · commit 95293cff8221 · 2019-05-10T12:28:20.000+02:00
o2sim_serial -&gt; o2-sim-serial
runTPC -&gt; o2-sim-tpc
O2SimDeviceRunner -&gt; o2-sim-device-runner
O2PrimaryServerDeviceRunner -&gt; o2-sim-primary-server-device-runner
O2HitMergerRunner -&gt; o2-sim-hit-merger-runner
o2sim -&gt; o2_sim

Couple of comments :

- the hard-coded string "o2sim" is used is _A LOT_ of places throughout
the code base. That should probably be fixed at some point.
- o2-sim-hit-merger-runner could also be named o2-sim-hitmerger-runner
depending on where one prefers to split the words.
- ditto for o2-sim-primary-server vs o2-sim-primaryserver
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -249,7 +249,7 @@ set(EXCLUDE_MACROS_FROM_TEST
   # Disabled from @mconcas: will be removed soon in any case
   ${CMAKE_SOURCE_DIR}/macro/run_vert_ca_its.C
 
-  # This macro is used by the o2sim tests, no need to re-check. Parallel tests
+  # This macro is used by the o2-sim tests, no need to re-check. Parallel tests
   # of the same macro are also breaking it
   ${CMAKE_SOURCE_DIR}/DataFormats/simulation/test/checkStack.C
 )
diff --git a/Detectors/TPC/simulation/CMakeLists.txt b/Detectors/TPC/simulation/CMakeLists.txt
@@ -80,9 +80,9 @@ O2_GENERATE_TESTS(
 
 # add the TPC run sim as a unit test (if simulation was enabled)
 if (HAVESIMULATION)
-  add_test_wrap(NAME tpcsim_G4 COMMAND ${CMAKE_BINARY_DIR}/bin/runTPC -n 2 -e TGeant4)
+  add_test_wrap(NAME tpcsim_G4 COMMAND ${CMAKE_BINARY_DIR}/bin/o2-sim-tpc -n 2 -e TGeant4)
   set_tests_properties(tpcsim_G4 PROPERTIES PASS_REGULAR_EXPRESSION "Macro finished succesfully")
-  add_test_wrap(NAME tpcsim_G3 COMMAND ${CMAKE_BINARY_DIR}/bin/runTPC -n 2 -e TGeant3)
+  add_test_wrap(NAME tpcsim_G3 COMMAND ${CMAKE_BINARY_DIR}/bin/o2-sim-tpc -n 2 -e TGeant3)
   set_tests_properties(tpcsim_G3 PROPERTIES PASS_REGULAR_EXPRESSION "Macro finished succesfully")
   # sets the necessary environment
   set_tests_properties(tpcsim_G3 tpcsim_G4  PROPERTIES ENVIRONMENT VMCWORKDIR=${CMAKE_SOURCE_DIR})
diff --git a/Utilities/MCStepLogger/CMakeLists.txt b/Utilities/MCStepLogger/CMakeLists.txt
@@ -51,7 +51,7 @@ O2_GENERATE_EXECUTABLE(
 
 # check correct functioning of the logger and the MC analysis chain
 if (HAVESIMULATION)
-  add_test_wrap(NAME mcloggertest COMMAND ${CMAKE_BINARY_DIR}/bin/runTPC -n 1 -e TGeant3)
+  add_test_wrap(NAME mcloggertest COMMAND ${CMAKE_BINARY_DIR}/bin/o2-sim-tpc -n 1 -e TGeant3)
   # tests if the logger was active
   set_tests_properties(mcloggertest PROPERTIES PASS_REGULAR_EXPRESSION "VolName.*COUNT")
   if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
diff --git a/doc/DetectorSimulation.md b/doc/DetectorSimulation.md
@@ -10,14 +10,14 @@ Detector simulation, the simulation of detector response from virtual particle e
   a) the generation of simple (energy deposit) traces in the detector due to the passage of particles and the interaction with the detector material.
   b) the conversion of those traces into (electronic) signals in the detector readout (usually called digitization).
  
-The first part is handled by the `o2sim` executable. The second part is handled in the `digitizer-workflow`.
+The first part is handled by the `o2-sim` executable. The second part is handled in the `digitizer-workflow`.
  
-# Documentation of `o2sim`
+# Documentation of `o2-sim`
 
-The purpose of the `o2sim` executable is to simulate the passage of particles emerging from a collision inside the detector and to obtain their effect in terms of energy deposits (called hits) which could be converted into detectable signals.
+The purpose of the `o2-sim` executable is to simulate the passage of particles emerging from a collision inside the detector and to obtain their effect in terms of energy deposits (called hits) which could be converted into detectable signals.
 
 ## Command overview
-* **Basic help:** Help on command line options can be obtained with `o2sim --help`
+* **Basic help:** Help on command line options can be obtained with `o2-sim --help`
 * **Typical example:** A typical (exemplary) invocation is of the form 
 
     ```o2sim -n 10 -g pythia8 -e TGeant4 -j 2 --skipModules ZDC,PHS``` 
@@ -94,9 +94,9 @@ o2sim --embedIntoFile o2sim.background.root
 Background events are sampled one-by-one until all events have been used. At that point the events start to be reused.
 
 #### 5. **How can I obtained detailed stepping information?**
-Run the simulation (currently only supported in combination with `o2sim_serial`) with a preloaded library:
+Run the simulation (currently only supported in combination with `o2-sim-serial`) with a preloaded library:
 ```
-MCSTEPLOG_TTREE=1 LD_PRELOAD=$O2_ROOT/lib/libMCStepLogger.so o2sim_serial -j 1 -n 10
+MCSTEPLOG_TTREE=1 LD_PRELOAD=$O2_ROOT/lib/libMCStepLogger.so o2-sim-serial -j 1 -n 10
 ```
 This will produce a file `MCStepLoggerOutput.root` containing detailed information about steps and processes (where, what, ...). The file can be analysed using a special analysis framework. See https://github.com/AliceO2Group/AliceO2/blob/dev/Utilities/MCStepLogger/README.md for more documentation.
 
diff --git a/macro/runSimRecMatchITSTPC.sh b/macro/runSimRecMatchITSTPC.sh
@@ -2,7 +2,7 @@ nEvents=10
 #To activate the continuos readout, assign a positive value to the rate 
 rate=50.e3
 
-o2sim -n $nEvents -m PIPE ITS TPC FRAME >& sim.log
+o2-sim -n $nEvents -m PIPE ITS TPC FRAME >& sim.log
 
 macroPath="$O2_ROOT/share/macro"
 preload="$macroPath"/loadExtDepLib.C
diff --git a/run/CMakeLists.txt b/run/CMakeLists.txt
@@ -1,10 +1,10 @@
 Set(Exe_Names
-  o2sim_serial
-  runTPC
-  O2SimDeviceRunner
-  O2PrimaryServerDeviceRunner
-  O2HitMergerRunner
-  o2sim
+  o2-sim-serial
+  o2-sim-tpc
+  o2-sim-device-runner
+  o2-sim-primary-server-device-runner
+  o2-sim-hit-merger-runner
+  o2-sim
 )
 
 Set(Exe_Source
@@ -55,7 +55,7 @@ if (HAVESIMULATION)
     DONT_FAIL_ON_TIMEOUT
     MAX_ATTEMPTS 2
     TIMEOUT 400
-    COMMAND ${CMAKE_BINARY_DIR}/bin/o2sim_serial -n 1 -e TGeant4 --isMT on -o o2simG4MT)
+    COMMAND ${CMAKE_BINARY_DIR}/bin/o2-sim-serial -n 1 -e TGeant4 --isMT on -o o2simG4MT)
   set_tests_properties(o2sim_G4_mt PROPERTIES PASS_REGULAR_EXPRESSION "Macro finished succesfully")
 
   add_test_wrap(NAME o2sim_checksimkinematics_G4
diff --git a/run/o2sim_parallel.cxx b/run/o2sim_parallel.cxx
@@ -197,7 +197,7 @@ int main(int argc, char* argv[])
   if (conf.getNEvents() <= 0) {
     LOG(INFO) << "No events to be simulated; Switching to non-distributed mode";
     const int Nargs = argc + 1;
-    std::string name("o2sim_serial");
+    std::string name("o2-sim-serial");
     const char* arguments[Nargs];
     arguments[0] = name.c_str();
     for (int i = 1; i < argc; ++i) {
@@ -242,9 +242,9 @@ int main(int argc, char* argv[])
     dup2(fd, 2); // make stderr go to file - you may choose to not do this
                  // or perhaps send stderr to another file
     close(pipe_serverdriver_fd[0]);
-    close(fd);   // fd no longer needed - the dup'ed handles are sufficient
+    close(fd); // fd no longer needed - the dup'ed handles are sufficient
 
-    const std::string name("O2PrimaryServerDeviceRunner");
+    const std::string name("o2-sim-primary-server-device-runner");
     const std::string path = installpath + "/" + name;
     const std::string config = localconfig;
 
@@ -299,7 +299,7 @@ int main(int argc, char* argv[])
                    // or perhaps send stderr to another file
       close(fd);   // fd no longer needed - the dup'ed handles are sufficient
 
-      const std::string name("O2SimDeviceRunner");
+      const std::string name("o2-sim-device-runner");
       const std::string path = installpath + "/" + name;
       execl(path.c_str(), name.c_str(), "--control", "static", "--id", workerss.str().c_str(), "--config-key",
             "worker", "--mq-config", localconfig.c_str(), "--severity", "info", (char*)nullptr);
@@ -327,7 +327,7 @@ int main(int argc, char* argv[])
     close(pipe_mergerdriver_fd[0]);
     setenv("ALICE_O2SIMMERGERTODRIVER_PIPE", std::to_string(pipe_mergerdriver_fd[1]).c_str(), 1);
 
-    const std::string name("O2HitMergerRunner");
+    const std::string name("o2-sim-hit-merger-runner");
     const std::string path = installpath + "/" + name;
     execl(path.c_str(), name.c_str(), "--control", "static", "--catch-signals", "0", "--id", "hitmerger", "--mq-config", localconfig.c_str(),
           (char*)nullptr);
diff --git a/run/startSim.sh b/run/startSim.sh
@@ -3,17 +3,17 @@
 NSIMWORKERS=$1
 
 killall -9 xterm
-killall -9 O2PrimaryServerDeviceRunner
-killall -9 O2SimDeviceRunner
-killall -9 O2HitMergerRunner
+killall -9 o2-sim-primary-server-device-runner
+killall -9 o2-sim-device-runner
+killall -9 o2-sim-hit-merger-runner
 
 topologyfile=${O2_ROOT}/share/config/o2simtopology.json
 
 # we have one primary distributor 
-xterm -geometry 80x25+0+0 -e "O2PrimaryServerDeviceRunner --control static --id primary-server --mq-config ${topologyfile} -n 20 -m PIPE TOF TRD TPC PHS EMC FIT MCH -g pythia8 -e TGeant3 | tee serverlog;bash" &
+xterm -geometry 80x25+0+0 -e "o2-sim-primary-server-device-runner --control static --id primary-server --mq-config ${topologyfile} -n 20 -m PIPE TOF TRD TPC PHS EMC FIT MCH -g pythia8 -e TGeant3 | tee serverlog;bash" &
 
 for i in `seq 1 ${NSIMWORKERS}`; do
-  xterm -geometry 80x25+500+0 -e "O2SimDeviceRunner --control static --id worker${i} --config-key worker --mq-config ${topologyfile} --severity info  | tee simlog${i};bash" &
+  xterm -geometry 80x25+500+0 -e "o2-sim-device-runner --control static --id worker${i} --config-key worker --mq-config ${topologyfile} --severity info  | tee simlog${i};bash" &
 done
 
 
@@ -22,5 +22,5 @@ done
 
 
 # one hit merger -> the time measures the walltime of the complete session
-time O2HitMergerRunner --id hitmerger --control static --mq-config ${topologyfile} | tee mergelog 
+time o2-sim-hit-merger-runner --id hitmerger --control static --mq-config ${topologyfile} | tee mergelog 
 

Original file line number	Diff line number	Diff line change
`@@ -249,7 +249,7 @@ set(EXCLUDE_MACROS_FROM_TEST`
`249`	`249`	`# Disabled from @mconcas: will be removed soon in any case`
`250`	`250`	`${CMAKE_SOURCE_DIR}/macro/run_vert_ca_its.C`
`251`	`251`
`252`		`- # This macro is used by the o2sim tests, no need to re-check. Parallel tests`
	`252`	`+ # This macro is used by the o2-sim tests, no need to re-check. Parallel tests`
`253`	`253`	`# of the same macro are also breaking it`
`254`	`254`	`${CMAKE_SOURCE_DIR}/DataFormats/simulation/test/checkStack.C`
`255`	`255`	`)`