Skip to content

Update READMEs #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benedikt-voelkel merged 1 commit into from
Nov 10, 2021
Merged

Update READMEs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions MCReplay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# TMCReplay
# MCReplay

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.

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.

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.
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.

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.

Expand Down Expand Up @@ -42,7 +42,7 @@ Replaying a previously recorded particle transport step-by-step. Mainly meant fo
tree
--geofilename arg (=o2sim_geometry.root)
ROOT geometry filename
--geokeyname arg (=FAIRGeom) key name inside geo file where to find
--geokeyname arg key name inside geo file where to find
geometry tree
-n [ --nevents ] arg (=-1) number of events to replay
-e [ --energycut ] arg (=-1) energy cut to be applied [GeV]
Expand Down
4 changes: 2 additions & 2 deletions MCStepLogger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ This package can be used to log and analyse the single steps computed by detecto
3 libraries are built

1. `libMCStepLoggerCore.so`
2. `libMCStepLoggerIntercept.so`
2. `libMCStepLoggerInterceptSteps.so`
3. `libMCStepLoggerAnalysis.so`

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.

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.

```bash
LD_PRELOAD=path_to/libMCStepLoggerIntercept.so o2-sim-serial -m MCH -n 10
LD_PRELOAD=path_to/libMCStepLoggerInterceptSteps.so o2-sim-serial -m MCH -n 10
```


Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MCStepLogger and TMCReplay
# MCStepLogger and MCReplay

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

Expand Down Expand Up @@ -33,5 +33,5 @@ That leaves you with

**Additional options**

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