Commit 84c122cb authored by Håkan Wennlöf's avatar Håkan Wennlöf
Browse files

Merge branch 'b-seed-doc' into 'v3.1-stable' 

[v3.1-stable] Docs: add description for random_seed_core

See merge request allpix-squared/allpix-squared!1183
parents d7a37f5c a9b5752f

doc/usermanual/03_getting_started/04_framework_parameters.md

+2 −1
Original line number Diff line number Diff line
@@ -61,7 +61,8 @@ The Allpix Squared framework provides a set of global parameters which control a 


- `random_seed_core`:

  Optional seed used for pseudo-random number generators in the core components of the framework. If not set explicitly,

  the value `random_seed + 1` is used.

  the value `random_seed + 1` is used. This generator is used to calculate alignment offsets as described in

  [Section 5.1](../05_geometry_detectors/01_geometry.md).



- `library_directories`:

  Additional directories to search for module libraries, before searching the default paths. See

doc/usermanual/05_geometry_detectors/01_geometry.md

+7 −0
Original line number Diff line number Diff line
@@ -65,6 +65,13 @@ properties attached to it: 
The detector configuration is provided in the detector configuration file as explained in

[Section 3.3](../03_getting_started/03_detector_configuration.md).



{{% alert title="Note" color="info" %}}

The framework parameter `random_seed_core` controls the seed used for the pseudo-random number generator that is responsible

for geometry operations before the simulation commences. Most notably, this concerns the alignment of individual detectors as

described above. By fixing the `random_seed_core` parameter but leaving `random_seed` free, multiple independent simulations

can be conducted with the same geometric alignment of detectors.

{{% /alert %}}



## Coordinate systems



Local coordinate systems for each detector and a global frame of reference for the full setup are defined. The global