Commit 0ced40f9 authored by Håkan Wennlöf's avatar Håkan Wennlöf
Browse files

Merge branch 'b-docu-doping' into 'v3.0-stable'

[v3.0-stable]  DopingProfileReader module documentation improvements

See merge request allpix-squared/allpix-squared!1025
parents 0cb65738 52beb99e
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ The following authors, in alphabetical order, have developed or contributed to A
* Mathieu Benoit, BNL, [mbenoit](https://gitlab.cern.ch/mbenoit)
* Thomas Billoud, Université de Montréal, [tbilloud](https://gitlab.cern.ch/tbilloud)
* Tobias Bisanz, CERN, [tbisanz](https://gitlab.cern.ch/tbisanz)
* Bogdan-Mihail Blidaru, Heidelberg University, [mblidaru](https://gitlab.cern.ch/mblidaru)
* Marco Bomben, Université de Paris, [mbomben](https://gitlab.cern.ch/mbomben)
* Koen van den Brandt, Nikhef, [kvandenb](https://gitlab.cern.ch/kvandenb)
* Carsten Daniel Burgard, DESY, [cburgard](https://gitlab.cern.ch/cburgard)
+20 −0
Original line number Diff line number Diff line
@@ -51,8 +51,28 @@ The following models for the doping profile can be used:
* `output_plots_single_pixel`: Determines if the whole sensor has to be plotted or only a single pixel. Defaults to true (plotting a single pixel).

## Usage

In the following example a doping profile map in APF format is loaded:

```ini
[DopingProfileReader]
model = "mesh"
file_name = "example_doping_profile.apf"
field_mapping = PIXEL_FULL
```

In the next example two regions with constant doping are used. Down to a depth of `25um` the doping concentration is $`6\times 10^{11} \,\text{cm}^{-3}`$, while below it the doping is set to $`5\times 10^{18} \,\text{cm}^{-3}`$:

```ini
[DopingProfileReader]
model = "regions"
doping_concentration = [[25um,6e11/cm/cm/cm],[50um,5e18/cm/cm/cm]]
```

Finally, a constant doping of $`-2.13\times 10^{15} \,\text{cm}^{-3}`$ is set for the entire sensor:

```ini
[DopingProfileReader]
model = "constant"
doping_concentration = -2.13e+15/cm/cm/cm
```
+1 −1
Original line number Diff line number Diff line
@@ -10,6 +10,6 @@ random_seed = 0
[DopingProfileReader]
log_level = DEBUG
model = "regions"
doping_concentration = [[20um, 100000000000], [100um, -3000000000000]]
doping_concentration = [[20um, 1e14/cm/cm/cm], [100um, -3e15/cm/cm/cm]]

#PASS Set constant doping concentration of -3e+15/cm/cm/cm at sensor depth 100um
+1 −1
Original line number Diff line number Diff line
@@ -10,6 +10,6 @@ random_seed = 0
[DopingProfileReader]
log_level = DEBUG
model = "constant"
doping_concentration = -2134560000000
doping_concentration = -2.13456e+15/cm/cm/cm

#PASS Set constant doping concentration of -2.13456e+15/cm/cm/cm