Commit ebd58185 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Add first round of proselint suggestions

parent d93de618
Loading
Loading
Loading
Loading
+6 −6
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ Type of the module?
1) unique
2) detector
#? 1
Creating directory and files...
Creating directory and files

Name:   MyNewPropagator
Author: John Doe (john.doe AT cern.ch)
+2 −2
Original line number Diff line number Diff line
@@ -8,11 +8,11 @@ description: "Simulation of cosmic muon flux using the DepositionCosmics module"
This example illustrates how the `DepositionCosmics` module is used to model the flux of cosmic muons in Allpix Squared. Python analysis code is included to calculate the flux through the detector from the MCParticle objects.

## Usage
First of all, change into the example directory. Run the simulation example from here:
First change into the example directory. Run the simulation example from here:
```shell
allpix -c cosmic_flux.conf
```
To analyse the tracks of the MCParticles, issue
To analyze the tracks of the MCParticles, issue
```shell
python analysis/analysis.py -l PATH_TO_ALLPIX_INSTALL/lib/libAllpixObjects.so
```
+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ description: "Simulation of the DESY testbeam setup with a EUDET telescope and R

This example is similar to the EUDET-type telescope example but with extra DUTs added to match the DESY testbeam setup with RD53a modules.
The setup consists of six telescope planes of MIMOSA26-type (EUDET beam telescope) and two RD53a modules centered in between the telescope arms:
DUT0 defined with 50x50um^2 pitch and DUT1 defined with 20x100um^2 pitch.
DUT0 defined with 50×50um^2 pitch and DUT1 defined with 20×100um^2 pitch.
Furthermore, one FEI4 reference plane is added as the last plane as in real testbeam setup.

The goal of this setup is to simulate the performance of RD53a modules with testbeam setup and to study multiple scattering effects with passive and extra material.
+1 −1
Original line number Diff line number Diff line
@@ -9,4 +9,4 @@ This example follows the "fast simulation" example but now replaces the simplifi

The setup is unchanged compared to the "fast simulation example" and consists of six Timepix-type detectors with a sensor thickness of 300um arranged in a telescope-like structure, inclined planes for charge sharing, and a defined alignment precision. The charge deposition is also performed by Geant4 with a stepping length of 10um.

Again, `DepositedCharge` and `PropagatedCharge` objects are not written to the output file as information about these objects cannot be accessed in data and thus are rarely used in the final analysis.
Again, `DepositedCharge` and `PropagatedCharge` objects are not written to the output file as information about these objects cannot be accessed in data and thus are rarely used in the analysis fo the simulation.
+2 −2
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ Similar to the SimpleTransferModule, this module combines individual sets of pro

It is also possible to simulate assemblies with tilted chips, with non-uniform coupling over the pixel matrix, by providing the tilting angles between the chips, the nominal and minimum gaps between the pixel pads, the pixel coordinates where the chips are away from each other by the minimum gap provided and a root file containing ROOT::TGraph with coupling capacitances *vs* gap between pixel pads.

The coupling matrix (imported via the `coupling_matrix` or the `coupling_file` configuration keys) represents the pixels coupling with a nominal gap between the chips, while the the ROOT file imported with the configuration key `coupling_scan_file` contains the coupling between the pixels for several gaps.
The coupling matrix (imported via the `coupling_matrix` or the `coupling_file` configuration keys) represents the pixels coupling with a nominal gap between the chips, while the ROOT file imported with the configuration key `coupling_scan_file` contains the coupling between the pixels for several gaps.

The coupling matrices can be used to easily simulate the cross-coupling in CCPDs with the nominal, and constant, gap between chips over the pixel matrix.
In such cases, the "central pixel" (center element of the coupling matrix) always receive 100% of the charge transferred while neighbor pixels, with lower coupling capacitance, gets a fraction of the charged transferred to the central pixel, normalized by the nominal capacitance (capacitance to central pixel).
@@ -48,7 +48,7 @@ The cross-coupling matrix, to be parsed via the matrix file or via the configura
```

The matrix center element, `cross_coupling_11` in this example, is the coupling to the closest pixel and should be always 1.
The matrix can have any size, although square 3x3 matrices are recommended as the coupling decreases significantly after the first neighbors and the simulation will scale with NxM, where N and M are the respective sizes of the matrix.
The matrix can have any size, although square 3×3 matrices are recommended as the coupling decreases significantly after the first neighbors and the simulation will scale with N×M, where N and M are the respective sizes of the matrix.

## Usage
This module accepts only one coupling model (`coupling_scan_file`, coupling_file or `coupling_matrix`) at each time. If more then one option is provided, the simulation will not run.
Loading