Skip to content

Commit 66bb9bb

Browse files
Benedikt Volkelbenedikt-voelkel
authored andcommitted
Update READMEs
1 parent b461f4a commit 66bb9bb

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

MCReplay/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# TMCReplay
1+
# MCReplay
22

33
This is a pseudo-detector-simulation engine based on the [Virtual Monte Carlo (VMC)](https://vmc-project.github.io/) package. It takes logged steps recorded by the `MCStepLogger` to **replay** the entire simulation.
44

55
The main objective is to be able to provide an engine to study the impact of parameter variations with. Eventually, this can be used to optimise (full-)simulation parameters in view of enhancing their speed and efficiency.
66

7-
The functionality is compiled into a separate library `libMCReplayCore`. Hence, `libMCStepLoggerIntercept` is completely independent which also allows to run the step logging against the `MCReplayEngine` engine.
7+
The functionality is compiled into a separate library `libMCReplayCore`. Hence, `libMCStepLoggerInterceptSteps` is completely independent which also allows to run the step logging against the `MCReplayEngine` engine.
88

99
The replay has been tested and is verified against [GEANT3_VMC](https://github.com/vmc-project/geant3) and [GEANT4_VMC](https://github.com/vmc-project/geant4_vmc) VMC interfaces.
1010

@@ -42,7 +42,7 @@ Replaying a previously recorded particle transport step-by-step. Mainly meant fo
4242
tree
4343
--geofilename arg (=o2sim_geometry.root)
4444
ROOT geometry filename
45-
--geokeyname arg (=FAIRGeom) key name inside geo file where to find
45+
--geokeyname arg key name inside geo file where to find
4646
geometry tree
4747
-n [ --nevents ] arg (=-1) number of events to replay
4848
-e [ --energycut ] arg (=-1) energy cut to be applied [GeV]

MCStepLogger/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ This package can be used to log and analyse the single steps computed by detecto
1010
3 libraries are built
1111

1212
1. `libMCStepLoggerCore.so`
13-
2. `libMCStepLoggerIntercept.so`
13+
2. `libMCStepLoggerInterceptSteps.so`
1414
3. `libMCStepLoggerAnalysis.so`
1515

1616
The first one contains core functionality to be used in depending packages and the same is true for the third one which contains analysis specific code.
1717

1818
The second allows for detailed debug information where stepping can be directed to standard output using the `LD_PRELOAD` env variable, which "injects" this library (which intercepts some calls) in the executable that follows in the command line.
1919

2020
```bash
21-
LD_PRELOAD=path_to/libMCStepLoggerIntercept.so o2-sim-serial -m MCH -n 10
21+
LD_PRELOAD=path_to/libMCStepLoggerInterceptSteps.so o2-sim-serial -m MCH -n 10
2222
```
2323

2424

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MCStepLogger and TMCReplay
1+
# MCStepLogger and MCReplay
22

33
### Build and install **with** `aliBuild`
44

@@ -33,5 +33,5 @@ That leaves you with
3333

3434
**Additional options**
3535

36-
* In order to disable the built of the `TMCReplay` engine, pass `-MCStepLogger_BUILD_TMCReplay=OFF` at configure time.
36+
* In order to disable the built of the `MCReplay` engine, pass `-MCStepLogger_BUILD_MCReplay=OFF` at configure time.
3737
* To enable testing, pass `-MCStepLogger_BUILD_TESTS=ON` at configure time.

0 commit comments

Comments
 (0)