Skip to content

Commit b4a5cf1

Browse files
authored
Add READMEs for Upgrade section (#4526)
1 parent 8215220 commit b4a5cf1

3 files changed

Lines changed: 53 additions & 0 deletions

File tree

Detectors/Upgrades/IT3/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# IT3
2+
Upgraded version of the ITS that includes upgraded truly-cylindrical inner barrel.
3+
4+
# Run the full simulation
5+
Provided O2 has been compiled with upgrades enabled, it is possible to simulate ITS 3 geometry within the `o2-sim` executable.
6+
7+
## Simulation
8+
IT3 module is enabled via the `-m IT3` parameter.
9+
In case of `PIPE` to be enabled, the size of the beam pipe is automatically scaled to what is foreseen for the upgrades.
10+
11+
Typical command to generate MC data:
12+
```bash
13+
o2-sim -m PIPE IT3 [...]
14+
```
15+
16+
## Reconstruction
17+
Currently, the reconstruction is driven the `macro/run_trac_alice3.C`, which takes as input the hits generated by simulation. Hits can be smeared upon request (see `kUseSmearing`).
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# IT4
2+
At the moment the IT4 name is a placeholder for barrel detector.
3+
4+
# Run the full simulation
5+
Provided O2 has been compiled with upgrades enabled, it is possible to simulate IT4 geometry within the `o2-sim` executable.
6+
7+
## Simulation
8+
IT4 module is enabled via the `-m IT4` parameter.
9+
In case of `PIPE` to be enabled, the size of the beam pipe is automatically scaled to what is foreseen for the upgrades.
10+
11+
Typical command to generate MC data:
12+
```bash
13+
o2-sim -m PIPE IT4 [...]
14+
```
15+
16+
## Reconstruction
17+
Currently, the reconstruction is driven the `macro/run_trac_alice3.C`, which takes as input the hits generated by simulation. Hits can be smeared upon request (see `kUseSmearing`).

Detectors/Upgrades/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- doxy
2+
\page refDetectorsITSMFT ITSMFT
3+
/doxy -->
4+
5+
# Upgrades
6+
This is a top page for detectors not included in Run 3 layout.
7+
8+
# Installation
9+
10+
To enable the compilation of this section it is required to prepend the `ENABLE_UPGRADES=ON` to the installation command, for instance:
11+
12+
```bash
13+
ENABLE_UPGRADES=ON aliBuild build O2 --defaults o2
14+
```
15+
16+
<!-- doxy
17+
* \subpage refIT3
18+
* \subpage refPostLS4
19+
/doxy -->

0 commit comments

Comments
 (0)